-
Notifications
You must be signed in to change notification settings - Fork 13
Wiki Sidebars and subfolders
Github wiki uses Gollum.
Pages are identified by a URL composed from their title, with spaces converted to '-'.
The page title namespace is flat - there is no folder hierarchy; page titles are required to be globally unique.
The wiki source files (markdown - .md) can be organised into a hierarchy of directories / folders.
This does not impact the above scheme which relates page title to URL.
By default, all wiki pages are shown in a 'Pages' sidebar.
Ref : Gollum Subpages
The Pages sidebar will be collapsed by default if the wiki defines a top-level _Sidebar.md
Each directory can have .md files _Header, _Footer and _Sidebar files (in Gollum wiki these are referred to as e.g. _Sidebar.ext because it supports extensions other than .md)
This information was gathered from these sources :
... _Header, _Footer and _Sidebar files are per-directory, but inherited if there is none present in a child folder.
File links can be relative to the source file (keep your files with your content).
- https://github.com/snowplow/snowplow/wiki/Ruby-Tracker This is a good example of what can be done and how to do it. To see the Markdown source files, clone the wiki repo : git clone https://github.com/snowplow/snowplow.wiki.git
() causes problems, and ':' and/or '.', so e.g. :
- change title :
from : (Task : Done) Split off the alias and marker layers
to : Task Done Split off the alias and marker layers
url : Task--Done-Split-off-the--alias-and-marker-layers