MkDocs template
Would you like to take some of your notes in Obsidian and make it public?
This template gives you an easy (and automated) way to publish your Obsidian notes (or blog!) on your Github pages.
With this template, you get these out-of-the-box:
[[wikilinks]]
from your vault in your published notes<https://username.github.io/repo-name/>
main
branch while creating the repo from the templaterepo-name/docs
folder.
Settings > Pages
and select the select the Source as your gh-pages
branch.Not working for you? Open an issue and let me know what went wrong.
By default, the sections and pages will follow the folder structure within /docs
. The folders and sub-folders will show up as sections. Try not to have white spaces in your folder and file names, as these will be converted to HTML links. The webpage heading will be the same as the first-level heading in the markdown note.
nav
option in the mkdocs.yml
configuration file at the root of this repo to set custom page navigation.
nav
can become cumbersome as the number of notes increase though!