/mkdocs-obsidian-support-plugin

A MkDocs plugin that supports obsidian to mkdocs convert

Primary LanguagePythonMIT LicenseMIT

mkdocs-obsidian-support-plugin

Plugin for mkdocs-material to convert semantic in documentation from obsidian to mkdocs-material.

\PyPI \PyPi Downloads \GitHub

pip install mkdocs-obsidian-support-plugin

Usage

Activate the plugin in mkdocs.yml

plugins:
  - obsidian-support

features

  • obsidian callout/block styled admonition -> mkdocs-material admonition
  • obsidian comment -> html comment
  • obsidian wikilink image -> mkdocs-material mdlink image & image with md_in_html
  • obsidian embed pdf -> html embed pdf
  • obsidian tags -> mkdocs-material search
  • obsidian html-tabs -> mkdocs-material content tabs

Note

Some features require setup to activate it. If you interested in specific feature, see the documentation.

github-pages

Tip

See https://ndy2.github.io/mkdocs-obsidian-support-plugin/ for more details

Other plugins that helps mkdocs + obsidian