docs/manual/index.org

 1#+TITLE: Orgstar
 2#+DESCRIPTION: A native macOS and iOS editor for org-mode files.
 3#+LEDE: Orgstar edits org files in place, alongside Emacs and the sync tools you already use.
 4#+OPTIONS: toc:nil
 5
 6Orgstar is an editor for [[https://orgmode.org][Org mode]] files on the Mac, with an app for
 7iPhone and iPad. It reads and writes the same plain-text files Emacs does, behaves the
 8way Org does where the two overlap, and leaves every byte you didn't change as it was.
 9
10On the Mac you get the editor with Emacs, Mac or Doom (Vim) keys, the agenda and a
11board view, capture templates, clocking, tables with formulas, code blocks and
12tangling, and export to HTML and Markdown (and to other formats through Emacs, if
13it is installed). The iOS app has the editor, agenda, capture, search, clocking,
14reminders, export and tangling.
15
16* Start here
17
18- [[file:install.org][Install]]: build the app from source.
19- [[file:quickstart.org][Quick start]]: add a folder, open a file, and the first keys to learn.
20- The manual, below: every feature, chapter by chapter.
21
22* The manual
23
241. [[file:guide/01-files-and-folders.org][Files, folders and buffers]]
252. [[file:guide/02-the-editor.org][The editor]]
263. [[file:guide/03-keys.org][Keys and commands]]
274. [[file:guide/04-outlines.org][Outlines and structure]]
285. [[file:guide/05-todos-and-tags.org][TODOs and tags]]
296. [[file:guide/06-dates-and-clocking.org][Dates, scheduling and clocking]]
307. [[file:guide/07-agenda.org][The agenda]]
318. [[file:guide/08-capture.org][Capture]]
329. [[file:guide/09-links.org][Links]]
3310. [[file:guide/10-tables.org][Tables]]
3411. [[file:guide/11-code-blocks.org][Code blocks]]
3512. [[file:guide/12-export.org][Export]]
3613. [[file:guide/13-configuration.org][Configuration]]
3714. [[file:guide/14-ios.org][iPhone and iPad]]
3815. [[file:guide/15-alongside-emacs.org][Working alongside Emacs and other tools]]
39
40* Principles
41
42- *The files are the source of truth.* There is no database of your notes. Orgstar
43  keeps an index for search and the agenda, rebuilt from the files whenever they change.
44- *Only your edits are written.* Saving rewrites the bytes you changed and nothing
45  else: indentation, line endings, encoding marks and unusual spacing elsewhere stay.
46- *Org's behaviour, not a lookalike.* Commands follow what Org 9.8 does, and are
47  checked against Emacs in the test suite. Where Orgstar can't do something the way
48  Org would, it says so and leaves the file alone rather than guessing.