https://github.com/amake/orgro

An Org Mode app for iOS and Android
https://github.com/amake/orgro

android editor emacs flutter ios org-mode viewer

Last synced: 5 days ago
JSON representation

An Org Mode app for iOS and Android

• Host: GitHub
• URL: https://github.com/amake/orgro
• Owner: amake
• License: gpl-3.0
• Created: 2020-02-17T14:44:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-28T23:44:36.000Z (13 days ago)
• Last Synced: 2024-11-29T00:25:02.693Z (13 days ago)
• Topics: android, editor, emacs, flutter, ios, org-mode, viewer
• Language: Dart
• Homepage: https://orgro.org
• Size: 2.84 MB
• Stars: 506
• Watchers: 21
• Forks: 23
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• stars - amake/orgro

README

        
[](https://apps.apple.com/us/app/orgro/id1512580074?uo=4) [](https://play.google.com/store/apps/details?id=com.madlonkay.orgro) [](https://f-droid.org/packages/com.madlonkay.orgro/)

# Orgro

An [Org Mode](https://orgmode.org/) app for iOS and Android

https://github.com/amake/orgro/assets/2172537/a3d841a3-84f3-4c34-9381-c73ab4dc9249

# What is Org Mode?

Imagine a plain-text markup language like Markdown, but married to an

application that is a literate programming environment and life organizer. In

[Emacs](https://www.gnu.org/software/emacs/).

# Why?

I started taking notes in Org Mode at work, then found myself wanting to view

them on my tablet in meetings. By default on iOS you can't open an `.org` file

at all, as the OS doesn't even know that it's plain text.

Other mobile Org Mode apps are focused on very different things like to-dos or

task management; Orgro is instead first and foremost a *viewer*, letting you see

and search the contents of your org files. (Recently it also gained editing

capabilities. I hope to enhance these in the future.)

I also wanted to try writing a parser with

[PetitParser](https://github.com/petitparser/dart-petitparser); the result

powers this application and is available as a separate library,

[org_parser](https://github.com/amake/org_parser).

# Features

- Syntax highlighting for most Org Mode syntax structures

- Expand and collapse sections, blocks, and drawers

- Reflow text for easy viewing on narrow screens

- Pretty table rendering

- Functional external links and section links (works well with

  [Org-roam](https://www.orgroam.com/))

- Visibility cycling

- Search

- Narrowing

- [Sparse Tree](https://orgmode.org/manual/Sparse-Trees.html)-style filtering

- "Reader mode" where extraneous markup is hidden

- Inline and block LaTeX rendering

- Jump to/from footnotes

- Display [Org Cite](https://orgmode.org/manual/Citations.html) citations

- Decrypt/encrypt [Org Crypt](https://orgmode.org/manual/Org-Crypt.html)

  sections (currently symmetric keys only)

- Editing capability

  ([details](https://orgro.org/faq/#can-i-edit-my-files-with-orgro))

- Honor document-local `#+STARTUP:` and `#+TODO:` directives

See the [manual](./assets/manual/orgro-manual.org) for details.

# Limitations

Many Org Mode syntax structures are highlighted but not meaningfully

interpreted.

# FAQ

See [here](https://orgro.org/faq/)

# Get it

Orgro is available on the

[App Store](https://apps.apple.com/us/app/orgro/id1512580074?uo=4),

[Google Play](https://play.google.com/store/apps/details?id=com.madlonkay.orgro),

and [F-Droid](https://f-droid.org/packages/com.madlonkay.orgro/), or you can

build and install from source:

1. Install [Flutter](https://flutter.dev/)

2. Clone this repo

3. Attach your device and do `flutter run` from the repo root

# Support Orgro

If you like this app, please show your support by [sponsoring the

author](https://github.com/sponsors/amake) ❤️