Skip to content

Mkdocs Obsidian is a combination of an Obsidian plugin and a Material mkdocs template that allows you to create a personal wiki site based on your Obsidian Vault.
It allows you to publish your notes on GitHub and customize the template to your liking.

Buy Me a Coffee at

The template support¶

  • Wikilinks ([[Links]])
  • File transclusion/embed, both wikilinks and Markdown links
  • Obsidian callout and custom callout
  • Folder notes and their citation
  • Custom attributes
  • Sharing state and custom folder hierarchy
  • Mobile and desktop compatibility
  • File mini preview on hover
  • Graph view 🎉 (using Obsidian Tools)

Github actions & Obsidian’s plugin¶


  1. Install the plugins through Obsidian Community or BRAT
  2. Template your blog using the template and configure it.
  3. Configure the plugin options:
    • Repo name
    • Your GitHub username
    • The GitHub token (available here)
    • The share key
  4. Add the sharing key as true in Obsidian’s note frontmatter
  5. Customize (or not) the folder options
  6. Run the commands through the file menu or commands palette.

For advanced configuration within Obsidian, see here

Quick blog installation tutorial¶

  1. Click on:1
  2. Use the name of your choice
  3. Click on Code → SSH; copy the link
  4. Run the following commands in your terminal:
    git clone [[PASTE THE LINK HERE]] publish_blog
    pip install -r requirements.txt

Moreover, don’t forget to configure GitHub to allow push! Check here for information about setting up Git.

Alternatively, you can use the Netlify app to deploy your blog! Just click here: Deploy to Netlify
Don’t forget to update the mkdocs.yml !

Deploys by Netlify

  1. You must be logged in to copy the template. You can also test locally by cloning via HTTPS using the command git clone, or by downloading the ZIP file from here ↩