index.org 6.6 KB

Org unicorn logo

Org Mode

Your life in plain text

A GNU Emacs major mode for convenient plain text markup — and much more.

Org mode is for keeping notes, maintaining to-do lists, planning projects, authoring documents, computational notebooks, literate programming and more — in a fast and effective plain text system.

Support via  Liberapay logo Liberapay GitHub logo GitHub Paypal logo PayPal

Created by Carsten Dominik in 2003, maintained by Bastien Guerry and developed by many others.

Highlights

:PROPERTIES: :HTML_CONTAINER_CLASS: columns no-heading :END:

Features

@@html:@@

resources/img/stars.svg

@@html:@@

Install

@@html:@@

resources/img/install.svg

@@html:@@

Quickstart

@@html:@@

resources/img/quickstart.svg

@@html:@@

Contribute

@@html:@@

resources/img/contribute.svg

@@html:@@

Elaboration + demo image ignore

Org is a highly flexible structured plain text file format, composed of a few simple, yet versatile, structures --- constructed to be both simple enough for the novice and powerful enough for the expert.

Get a glimpse of the expressive power Org offers in the example below. Click the headings and links to discover how Org intelligently folds structural content.

Further reading

:PROPERTIES: :CUSTOM_ID: reading :END:

Beyond the quickstart and the manual, Org has a guide and a wealth of community-written documentation on Worg .

Nearly every Org user has a story to tell about how Org enables and empowers them --- some have found it so useful that they have written (scientific) papers about the value of Org for conducting reproducible research. Some have produced third party tools to enjoy Org outside of Emacs, such as mobile applications.

More Org

:PROPERTIES: :CUSTOM_ID: more :END:

The de facto mimetype for Org files is text/org. Org files use the ~.org~ extension. Most operating systems don't know to open ~.org~ files in Emacs, but they can be configured to do so without much effort.

While the reference implementation of Org in Emacs lisp is by far the most featureful, there are many additional tools that work with Org.

Tools that work with Org

Worg, a World of Org

:PROPERTIES: :CUSTOM_ID: worg :END:

Org and Org-mode have so many use cases that it is simply not possible to easily document them, let alone show them all off on a single page. As a result, Worg serves as a community wiki and provides a place to document and share information about all aspects of using and working with Org.

For example, Worg contains:

Worg is maintained as a Git repository of Org files that are published as an HTML website. New contributors are welcome.


~$ git clone https://git.sr.ht/~bzg/worg