Org-Mode Markup Kitchen Sink
Updated  2022-October-24

• bold
• italic
• underline
• strike through
• code
• commands

small example

Within links:

This is an example of some syntax highlighting within links and such.

gnu

Five or more dashes produce a horizontal line.

Headings are pre-pended by a set of asterisk characters followed by at least one space character.

One asterisk is a heading of level 1, two asterisks for level 2 and so forth:

* Heading of level 1
** Heading of level 2
*** Heading of level 3
*** Another heading of level 3
** Again a heading of level 2

simple list:

• Org-mode
• Lists

enumerate:

1. Emacs
2. Org-mode
3. Lists

mixed with checkboxes:

• Clean out garage

  1. get stuff out

     • be careful with that axe, Eugene

  2. get rid of old stuff

     • sell on the Internet?
     • try to use rubbish as birthday presents for family
  3. repaint garage
  4. put stuff back in

An EXAMPLE block is rendered as is, keeping line breaks and not interpreting content:

An example in an EXAMPLE block.
Second line within this block.

This *is* an /example/ of _some_ syntax +highlighting+.

Content within a QUOTE block may get different line breaks when exported/rendered and interprets Orgdown text formatting:

An example in an QUOTE block. Second line within this block.

This is an example of some syntax highlighting.

VERSE blocks are similar to quote blocks, but they respect line breaks:

SRC blocks contain source code snippets. Text formatting is ignored, line breaks preserved.

A Python source code example:

  def my_test(myvar: str = 'foo bar'):
      """
      This is an example function.

      @type  myvar: str = 'foo bar': number
      @param myvar: str = 'foo bar': FIXXME
      """

      mynewvar: str = myvar + ' additional content'
      return mynewvar

  print("Hello " + my_text('Europe!'))

A shell script example:

echo "Hello Europe!"
FOO="foo bar"
echo "A test with ${FOO}"
pwd

Comment lines contain content which is not visible in any derived document, such as a PDF document or a web view.

hash space:

space hash space:

space space hash space:

Comment block:

• https://gitlab.com/publicvoit/orgdown → plain URL without brackets
• https://gitlab.com/publicvoit/orgdown → URL with brackets without description
• Orgdown homepage → URL with brackets with description

Tables do not have to be properly aligned. As long as the correct number of vertical bars per line is met, text formatting is applied.

Don't worry about alignment if you don't have proper tool support. This is a perfectly valid table:

More columns:

Formatting: