/github-orgmode-tests

This is a test project where you can explore how github interprets Org-mode files

Note: a complete list of these features including keyboard shortcuts, links, and descriptions is available on https://github.com/novoid/github-orgmode-tests

This page demonstrates Org-mode features that are (or are not) supported by github which is using an (old) version of org-ruby.

Last GitHub feature render check and last table update: <2020-10-15 Thu>

Featurestatus
Text formatting:WORKS:
Text formatting within other syntax elements:WORKS:
Lists:PARTLY:
Headings with TODO items:FAILS:
Drawers:FAILS:
blocks (docu):PARTLY:
EXAMPLE block:WORKS:
QUOTE block:WORKS:
VERSE block:FAILS:
SRC block:WORKS:
python:WORKS:
shell:WORKS:
ruby:WORKS:
ditaa:WORKS:
session with shell and R:WORKS:
QUOTE block:WORKS:
HTML block:FAILS:
LATEX block (docu):FAILS:
NOTES block:FAILS:
comments (docu):WORKS:
Noexport tag of heading:WORKS:noexport:
links (docu):PARTLY:
states; TODO items (docu):PARTLY:
tags (docu):FAILS:
tables simple (docu):PARTLY:
tables complex (docu, tutorial):PARTLY:
column view (docu):FAILS:
dates & time (docu):WORKS:
clocking time (docu):PARTLY:

Featuretest

Text formatting

small example

Text formatting within other syntax elements

Within links:

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

~gnu~

Table:

Example
http://orgmode.org
Org mode
This is an example of some syntax highlighting within links and such.

Lists:

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

Headings:

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

Lists

  • MISSING:
    • Checkbox rendering/alignment
    • Reusing same enumerate bullet symbols (dash, numbers, …)

simple list:

  • Org mode
  • Lists
  • [ ] unchecked checkbox
  • [X] checked checkbox
  • [-] undecided checkbox (C-u C-u C-c C-c)

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. [X] get rid of old stuff
      • using eBay?
      • try to use rubbish as birthday presents for family
    3. [ ] repaint garage
    4. [X] put stuff back in

Headings with TODO items

  • MISSING
    • display of TODO keywords

Clean out garage [0/4]

get stuff out

  • be careful with that axe, Eugene

get rid of old stuff

  • using eBay?
  • try to use rubbish as birthday presents for family

repaint garage

put stuff back in

Drawers

  • MISSING:
    • rendering of drawers

NEXT Test with category property

blocks (docu)

  • including babel (docu)

EXAMPLE block

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

This *is* an /example/ of _some_ syntax +highlighting+ within =links= and ~such~.

QUOTE block

Will be wrapped:

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

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

VERSE block

  • MISSING:
    • rendering of the block

SRC block

python

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!'))
(message (concat "Hello" "Europe!")) ;; inline comment

shell

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

ruby

require 'date'
"This file was last evaluated on #{Date.today}"

ditaa

+---------+
| cBLU    |
|         |
|    +----+
|    |cPNK|
|    |    |
+----+----+

session with shell and R

cd ~/archive/events_memories && du -sc * |grep -v total

Using result set “directories” from above as “dirs” in R below:

pie(dirs[,1], labels = dirs[,2])

QUOTE block

Will be wrapped:

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

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

HTML block

  • MISSING:
    • rendering of the block

This is a paragraph with a link within.

LATEX block (docu)

  • MISSING:
    • rendering of the block
    • some special characters
  • Greek characters
    • Working outside of block: α β φ
    • not working: \LaTeX{} $\varphi$

NOTES block

  • MISSING:
    • rendering of the block

Notes blocks are not standard Org mode. However, org-reveal is using it for handout notes so I would like to include it here.

comments (docu)

Comment lines:

space hash space:

space space hash space:


Comment block:

links (docu)

  • MISSING:
    • <<link>>
    • following id: links
    • custom links
      • without your Emacs config, those links are impossible to follow
      • rendering somehow would be fine
    • footnotes

todo: target

# <<link>>

[fn:myotherlabel] This is a footnote from reference above. [fn:2] This is a footnote with a simple number as label.

Footnotes aren’t working

heading with PROPERTIES drawer containing ID

Should have #myexampleid anchor, doesn’t work as of 2021-04-11

eading with PROPERTIES drawer containing CUSTOM_ID

Should have #myexamplecustomid anchor, doesn’t work as of 2021-04-11

states; TODO items (docu)

  • MISSING:
    • todo keywords
    • dependencies from within drawers

making dependencies explicit

example with chain siblings

NEXT buy bike
take tour
goto hospital

priorities (docu)

[#A] example

NEXT [#B] example

breaking down in subtasks (docu)

example [1/3] [33%]

subtask 1
subtask 2
subtask 3

tags (docu)

  • MISSING:
    • rendering tags

example

tables simple (docu)

  • MISSING:
    • number alignment
Heading1head2
entry42
foo21.7
end99.99

tables complex (docu, tutorial)

  • MISSING:
    • Tables are concatenated unfortunately and alignment fails.
US-DollarEUR
10.76481836
WhenWhatUSDEUR
2012-02-03Taxi Graz-Airport18.00
2012-02-03Taxi Seattle Airport25.0019.12
2012-02-13Taxi7.005.35
2012-02-14Taxi8.006.12
2012-02-17Taxi to Airport SeaTac35.0026.77
2012-02-22Taxi Airport-Graz16.00
91.36

column view (docu)

  • MISSING:
    • no support for those things

example sub-item

NEXT [#B] another example

dates & time (docu)

  • C-c . insert active <2012-04-23 Mon> (with C-u: <2012-04-23 Mon 19:14>)
  • C-c ! insert inactive [2012-04-23 Mon] (with C-u: [2012-04-23 Mon 19:14])

clocking time (docu)

  • MISSING:
    • drawer information

example sub-hierarchy with report

Clock summary at [2012-11-19 Mon 11:17]

HeadlineTime
Total time27:16

example item

another item

MISC Ad-Hoc Testing

This sub-hierarchy is here to test specific stuff.

You can ignore everything starting from here.

Headings

heading with properties

tables

head1head2head3
text42-----
me@server.example.com23:-)
65

links

examples

verse:

quote:

This is an example. Second line. Very long line with many characters showing the wordwrap feature or the not existing word wrap feature

only colon:

This is an example.
    Second line.
Very long line with many characters showing the wordwrap feature or the not existing word wrap feature

non-specific source:

This is an example.
    Second line.
Very long line with many characters showing the wordwrap feature or the not existing word wrap feature

python source:

if VALUE and dummy < 42:
    execute_something("Dummy text", 23)

Underscores_like_this

  • me_low
  • 2_8
  • *.org_archive
  • *.org\_archive
  • *.org\_archive

Orgmode examples

Das hier ist eine Erklärung von dem Ganzen:

Und in der Org-mode-Datei wird das dann so angewendet: