docs/manual/index.org
48 lines · 2456 bytes
Orgstar
Orgstar is an editor for Org mode files on the Mac, with an app for iPhone and iPad. It reads and writes the same plain-text files Emacs does, behaves the way Org does where the two overlap, and leaves every byte you didn't change as it was.
On the Mac you get the editor with Emacs, Mac or Doom (Vim) keys, the agenda and a board view, capture templates, clocking, tables with formulas, code blocks and tangling, and export to HTML and Markdown (and to other formats through Emacs, if it is installed). The iOS app has the editor, agenda, capture, search, clocking, reminders, export and tangling.
Start here
- Install: build the app from source.
- Quick start: add a folder, open a file, and the first keys to learn.
- The manual, below: every feature, chapter by chapter.
The manual
Principles
- The files are the source of truth. There is no database of your notes. Orgstar keeps an index for search and the agenda, rebuilt from the files whenever they change.
- Only your edits are written. Saving rewrites the bytes you changed and nothing else: indentation, line endings, encoding marks and unusual spacing elsewhere stay.
- Org's behaviour, not a lookalike. Commands follow what Org 9.8 does, and are checked against Emacs in the test suite. Where Orgstar can't do something the way Org would, it says so and leaves the file alone rather than guessing.