Skip to content

A plugin for Python-Markdown that allows you to use callouts as in Obsidian.

License

Notifications You must be signed in to change notification settings

GooRoo/obsidian-callouts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Obsidian callouts for Python-Markdown

Made by Ukrainian License

This is an extension for Python-Markdown which allows you to use Obsidian-style callouts:

> [!warning]
> Here's a callout block.

> [!tip] Callouts can have custom titles
> Like this one.

It will be rendered kinda like this:

Warning

Here's a callout block.

[!TIP] Callouts can have custom titles Like this one.

For a full reference, please, see the Obsidian's documentation on this.

Usage

Simply enable the extension like this:

import markdown

md = markdown.Markdown(extensions=['obsidian_callouts'])
print(md.convertFile('page.md'))

MkDocs

It can be used with MkDocs as following:

# mkdocs.yml
markdown_extensions:
  - obsidian_callouts

It is also installed along with my mkdocs-obsidian-bridge.

Credits

During the implementation of this plugin, I was using the official Python-Markdown as an inspiration and the example.

About

A plugin for Python-Markdown that allows you to use callouts as in Obsidian.

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Languages