emacs Org-mode Markup syntax


Example

Org provides a full markup language which helps structuring the document, and is reflected as accurately as possible when exporting to other formats (like HTML or LaTeX).

Structure

Document title

#+TITLE: This is the title of the document

Sectioning

* First level
** Second level

Lists

Ordered list (items can also be numbered like '1)', with a perenthesis):
1. foo
2. bar
3. baz
Unordered list (items can also start with '+' or '*'):
- foo
- bar
- baz
Description
- lorem ipsum :: this is example text
- foo bar :: these are placeholder words

Checkboxes

Every item in a plain list can be made into a checkbox by starting it with the string ‘[ ]’.

* TODO [2/4] (or [50%])
  - [-] call people [1/3]
    - [ ] Peter
      - [X] Sarah
      - [ ] Sam
  - [X] order food
  - [ ] think about what music to play
  - [X] talk to the neighbors
  • C-c C-c org-toggle-checkbox
  • C-c C-x C-b org-toggle-checkbox
  • M-S- org-insert-todo-heading
  • C-c C-x o org-toggle-ordered-property
  • C-c # org-update-statistics-cookies

Emphasis and monospace

You can make words *bold*, /italic/, _underlined_, =verbatim=
and ~code~, and, if you must, ‘+strike-through+’.

Text in the code and verbatim string is not processed for Org mode specific syntax, it is exported verbatim.

Links and references

Links

Org-mode will recognize URL formats and activate them as clickable links. However, links can be explicitly declared like this:

You will find more information in the [[http://orgmode.org/org.html][Org Manual]].

or alternatively :

The org manual is located here: [[http://orgmode.org/org.html]]

Footnotes

Footnotes can either be named:

See the org manual[fn:manual] to get more details.
...
[fn:manual] You will find it here: http://orgmode.org/org.html

or anonymous and inline:

See the org manual[fn:: You will find it here: http://orgmode.org/org.html]
to get more details.