CLOSED: [2017-06-04 Sun 18:15]
:PROPERTIES:
:ID: 2017-06-04-GitHub-Org-Wiki
:CREATED:  [2017-06-04 Sun 17:59]
:END:
:LOGBOOK:
- State "DONE"       from "DONE"       [2017-06-07 Wed 17:36]
- State "DONE"       from "NEXT"       [2017-06-04 Sun 18:15]
:END:

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 [[id:2019-09-25-using-orgmode][blog series "Using Org Mode Features"]]

Please do read [[id:2019-09-25-using-orgmode][my "Using Org Mode Features" (UOMF) series page]] for
explanations on articles of this series.

Here are some lessons learned related to creating a [[https://guides.github.com/features/wikis/][GitHub Wiki]] using
[[https://orgmode.org][Org-mode]] markup files for my [[https://github.com/novoid/lazyblorg/wiki][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 [[https://github.com/bdewey/org-ruby][Orgmode parser of GitHub]] is not perfect.