Skip to main content

A MkDocs plugin that supports obsidian to mkdocs convert

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-obsidian-support-plugin-1.3.3.tar.gz (11.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page