Skip to content

Obsidian GitHub Publisher

= this.title🔗

= ("[Website](" + this.url + ")") | = ("[Source](" + this.source + ")") | Template repo
= ("> " + this.desc-short)

Features🔗

  • 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)

MkDocs Template🔗

See also MkDocs.

Clone template repo and configure manually (all $ variables in mkdocs.yml) or use GitHub Action as describe in repo Readme.

Drop notes in directory docs/.

Run mkdocs serve for local editing or push to repository with Github Pages set up to build pages in a pipeline and publish them to GitHub Pages.

References🔗