UOMF: Writing a GitHub Wiki Using Org Mode Syntax

Update 2017-06-04: Clarified broken links to sub-folders

Update 2017-06-07: Confirmation on ignored sub-directories

Silent update 2019-09-25: added to blog series "Using Org Mode Features"

Please do read my "Using Org Mode Features" (UOMF) series page for explanations on articles of this series.

Here are some lessons learned related to creating a GitHub Wiki using Org-mode markup files for my lazyblorg project.

• Don't use spaces in file names.
  • Linking to them is tedious since %20 gets added to paths, resulting in broken links and so forth.
• Don't use sub-directories.
  • Altough you are able to clone the repos and create sub-directories, all file links are created as if the file is in the root directory. A link to file:my folder/my file.org does not work but file:my file.org works.
  • Therefore: Place your files in the root directory only.
• Dashes in file names gets replaced by spaces.
• The file name is the first heading, so start with the introduction paragraph in your Org-mode file.
• The Orgmode parser of GitHub is not perfect.