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 GitHub

pip install mkdocs-obsidian-support-plugin

Usage


Activate the plugin in mkdocs.yml

plugins:
  - search
  - obsidian-support

features


1. obsidian callout -> mkdocs admonition


in obsidian,

>[!note] haha
>I am obsidian callout!
>
>I became mkdocs admonition!

rendered as with obsidian callout

img.png

in mkdocs-material, this is equivalent to mkdocs-material admonition

!!!note "haha"

    I am obsidian callout!
    
    I became mkdocs admonition!

this plugin convert callout to admonition based on regex. finally it rendered as below in mkdocs-material

img.png

💡 common types that obsidian callout and mkdocs-material admonition support

  • note
  • abstract
  • info
  • tip
  • success
  • question
  • warning
  • failure
  • danger
  • bug
  • example
  • quote

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-0.1.3.tar.gz (3.4 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