README

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

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.

Other plugins that helps mkdocs + obsidian

• https://github.com/sondregronas/mkdocs-callouts
• https://github.com/orbikm/mkdocs-ezlinks-plugin

Comments