Skip to content

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

Notifications You must be signed in to change notification settings

DmitryMaletin/github-orgmode-tests

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 

Repository files navigation

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.

Featurefailedworked
simple text formatting<2013-02-26 Tue>
comment lines<2017-09-17 Sun>
multi line comment block<2017-09-17 Sun>
simple lists<2013-02-26 Tue>
lists with checkboxes<2014-04-13 Sun>
nested lists<2013-10-17 Thu>
Headings with TODO items<2014-04-13 Sun>
hide Drawers<2013-10-17 Thu>
simple blocks<2013-02-26 Tue>
simple links<2013-02-26 Tue>
footnotes<2014-04-13 Sun>
custom links<2014-04-13 Sun>
link to ID<2014-04-13 Sun>
states<2014-04-13 Sun>
chain siblings<2014-04-13 Sun>
priorities<2013-02-26 Tue>
subtask statistics<2013-02-26 Tue>
tags<2014-04-13 Sun>
simple tables<2013-02-26 Tue>
tables formatting: bold<2013-10-17 Thu>
tables formatting: align numbers<2014-04-13 Sun>
hiding TBLFM<2013-02-26 Tue>
column view<2014-04-13 Sun>
showing timestamps<2013-02-26 Tue>
showing clocking summaries<2013-02-26 Tue>
showing clocking drawers<2014-04-13 Sun>
simple SRC blocks<2013-02-26 Tue>
SRC block formatting as verbatim<2013-02-26 Tue>
SRC blocks with syntax highlighting<2014-04-13 Sun>
LaTeX α β φ<2013-10-17 Thu>
LaTeX simple formulas<2014-04-13 Sun>
LaTeX blocks<2014-04-13 Sun>

Featuretest

Text formatting

small example

Lists

simple list:

  • Emacs
  • Org-mode
  • Lists

enumerate:

  1. Emacs
  2. Org-mode
  3. Lists
  • Clean out garage
    1. [ ] get stuff out
      • [ ] be careful with that axe, Eugene
    2. [ ] get rid of old stuff
      • using eBay?
      • try to use rubbish as birthday presents for family
    3. [ ] repaint garage
    4. [ ] put stuff back in

Headings with TODO items

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

NEXT Test with category property

simple blocks (docu)

Some example from a text file.
  • more of it in the Babel section later on

comments (docu)

Comment lines:

space hash space:

space space hash space:


Comment block:

Noexport tag of heading

This heading is tagged with noexport and therefore should not be exported. Whatever this means for GitHub. ;-)

links (docu)

todo: target

# <<link>>

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

heading with PROPERTIES drawer containing ID

foo bar

states; TODO items (docu)

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)

example

tables simple (docu)

Heading1head2
entry42
foo21.7
end99.99

tables complex (docu, tutorial)

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)

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)

example sub-hierarchy with report

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

HeadlineTime
Total time27:16

example item

another item

source code (docu)

def foo(argument):
     print "Hello World"

babel (docu)

babel simple (doc)

shell

pwd

ruby

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

python

return 42 + 7

ditaa

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

babel advanced

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])

LaTeX (docu)

Greek characters α β φ \LaTeX{} $\varphi$

Testing

Headings

heading with properties

tables

head1head2head3
text42-----
[email protected]23:-)
65

links

- indirect URL

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:

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published