Use MkDocs to publish my Obsidian vault

Overview:

Workflow:

• Write notes in Obsidian
• Prepare files to publish with MkDocs
• Deploy in GitHub Pages or any static site hosting (like Render, Netlify)
• or use Github Publisher plugin to send the notes stored in Obsidian to a GitHub repo, then publish this repo with mkdocs

Discussion of workflow in Obsidian forum

• My Obsidian & Mkdocs workflow
• Obsidian Mkdocs : A free Publish Alternative WorkFlow

Showcase: Tarek Shehata, Obsidian Mkdocs Publisher

Thoughts

• My 2nd favorite if I need to publish my Obsidian vault
• has dark theme, built-in navigation bar, search feature, Next and Previous UI links at the end of each doc page, support mermaid.js diagram using mkdocs-mermaid2-plugin
• open source, static site generator, documents are markdown md files
• has guide to integrate 3rd party comment system
• Suitable for technical project documentation.
• mkdocs-material support tags in notes only in Insider tier
• mkdocs-material has native support for diagrams with mermaid.js in Insider tier
• mkdocs-material has Insider sponsorship starting at USD 10 / month.

Related resources:

Tutorial:

• Current best tutorial that I used: Obsidian Mkdocs : A free Publish Alternative WorkFlow
• Starfall Projects | Create multiple websites from one Obsidian vault
• the-penguin-book-mkdocs | GitHub | Tutorial to publish notes with mkdocs
• Publish your Obsidian Notes | GitHub
• free-lightweight-obsidian-publisher | GitHub

Showcase:

• EuroPython Conference | Documenting with MkDocs | Youtube
• Steve Martinelli | 5 Features I Like About Material for MkDocs

Tools:

• Mkdocs Obsidian template | GitHub
• A Material Design theme for MkDocs | GitHub
• obsidian-export | GitHub, CLI program and a Rust library to export an Obsidian vault to regular Markdown
• mkdocs-static-i18n | GitHub
• GruvDoc | GitHub

---

Tags

1. cat.tut

---

Backlinks

• Tools for Thought
• Publish with Obsidian Github Publisher
• GitHub Publisher