HowTo Publish Obsidian Notes

Quick start

1. Clone this repository into your Obsidian folder/vault. Or just use it without Obsidian

2. Move your notes that you would like to make public to the repo-name/docs folder.

   • Easiest way to do this would be using drag and drop within Obsidian

3. Commit and push the changes. Github actions will take care of the rest, publishing your notes using MkDocs, with the Material theme.

Configuring your website

How do I arrange notes as sections and pages?

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.

The Materials theme provides multiple options to arrange sections, use navigation tabs, and many other helpful navigation setups

---

References: https://mvbbb.github.io/ Related: