{"repo":"jobindjohn/obsidian-publish-mkdocs","free":true,"listed":false,"github":"https://github.com/jobindjohn/obsidian-publish-mkdocs","clone":"git clone https://github.com/jobindjohn/obsidian-publish-mkdocs.git","description":"A Template to Publish Obsidian/Foam Notes on Github Pages (uses MkDocs)","language":null,"stars":652,"topics":["obsidian-md","mkdocs","notes","digital-garden","second-brain","mkdocs-material","github-pages","gh-pages","obsidian-notes","materials-theme"],"license":"CC0-1.0","category":"docs-static-sites","readme_excerpt":"Publish your Obsidian Notes 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 : - an awesome website based on Material theme, complete with a search bar (Checkout this template repo published here) - get the Obsidian/Roam style [[wikilinks]] from your vault in your published notes - Toggle between light and dark mode - Blog folder Quick start 1. Create a new github repository using this template . Click the green button at the top or use this link. 2. Give a name to your repository. By default your notes will be published at - Copy only the main branch while creating the repo from the template 3. Clone the repository you generated into your Obsidian folder/vault. 4. 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 5. Commit and push the changes. Github actions will take care of the rest, publishing your notes using MkDocs, with the Material theme. 6. Go to 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. Configuring your website How do I arrange notes as sections and pages? By default, the sections and pages will follow the folder structure within /docs . The folders and sub-folders w","default_branch":null,"files":null,"tree":[],"storefront":"/r/jobindjohn","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/jobindjohn/obsidian-publish-mkdocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}