Organize Your Wiki

Repositorium organizes your wiki content in files and subdirectories. You can use any structure you want, but here are some tips on how to best structure your wiki.

Index files

If you navigate to the root directory or any subdirectory of your wiki, Repositorium will look for a file named index.md in that directory. If it can't find one, it will instead display a directory index listing all the files and subdirectories in that folder. So if you want a custom index for a directory (for example a "Welcome" page in the root folder to welcome visitors to your wiki), simply make a file called index.md in that directory.

Sidebar files

Repositorium will try to display a custom sidebar on the right side of the page. It will search for a sidebar file to display in the following order:

1. In the YAML frontmatter of Markdown files you can specify a sidebar file to display.
2. If the directory of the file contains a sidebar.md file, that will be displayed.
3. If any of the folder's parent directories contain a file named sidebar.md, that will be displayed.

A simple example: If you are viewing the file diary/2016/november/19th.md, Repositorium will look for a sidebar directive in the YAML frontmatter. If it can't find one, it will look for a file named sidebar.md in the diary/2016/november folder, then in the diary/2016 folder, in the diary folder and finally in the root folder of your repository.

If there is no sidebar file found in any of the above locations, the sidebar will simply display a directory index listing all the files and subdirectories in that folder.