An mdformat plugin for `obsidian`.
Project description
mdformat-obsidian
An mdformat plugin for Obsidian Flavored Markdown. This plugin directly supports Callouts and defers the rest of the formatting to additional plugins installed automatically.
[!NOTE] The format for GitHub Alerts differs slightly from Obsidian, so they are not fully compatible. Obsidian supports folding, custom titles, and is case insensitive. To improve interoperability, this package makes the stylistic choice of capitalizing the text within
[!...]
.
mdformat
Usage
Add this package wherever you use mdformat
and the plugin will be auto-recognized. No additional configuration necessary. See additional information on mdformat
plugins here
Pre-Commit
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
- mdformat-obsidian
pipx
pipx install mdformat
pipx inject mdformat mdformat-obsidian
HTML Rendering
To generate HTML output, obsidian_plugin
can be imported from mdit_plugins
. For more guidance on MarkdownIt
, see the docs: https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser
from markdown_it import MarkdownIt
from mdformat_obsidian.mdit_plugins import obsidian_plugin
md = MarkdownIt()
md.use(obsidian_plugin)
text = "> [!tip] Callouts can have custom titles\n> Like this one."
md.render(text)
# <blockquote>
# </blockquote>
[!WARNING] This package does not properly handle replacing the
blockquote
outerdiv
with adiv
for accessibility. This should be possible withmarkdown-it
, but I haven't yet found a way.
Contributing
See CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mdformat_obsidian-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 009bee705c85fa17bed5138ef189c158b3d1197c4cb6cce6a6fcbfdfeae6a4af |
|
MD5 | 54f3f9b314fbbcb851d5969e8f4f6a23 |
|
BLAKE2b-256 | 6c097fccfc40d9bcdd2fe2543d66ae8971370144d23d60842d27d2615bf11ceb |