Skip to main content

A Python-Markdown plugin for Obsidian-style callouts.

Project description

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.

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

obsidian_callouts-1.0.1.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obsidian_callouts-1.0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_callouts-1.0.1.tar.gz.

File metadata

  • Download URL: obsidian_callouts-1.0.1.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for obsidian_callouts-1.0.1.tar.gz
Algorithm Hash digest
SHA256 4ed5ddb9dbdd2340d845cd5efd412fbfe9011ccd7c2040b27f62d0998b0cef1d
MD5 f42e154887f39ec946341f89707a2f73
BLAKE2b-256 cb9d2611de6c8ded3bab57fa72558e73d173db6e0458580363dfb9b1e2906d4b

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_callouts-1.0.1.tar.gz:

Publisher: build-deploy.yml on GooRoo/obsidian-callouts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file obsidian_callouts-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_callouts-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a373e8be931c2cf574990f57061db5f724755f27aeb3aac23eb7436fde7f819b
MD5 cb197c0b36d3b1e76070c7549546fb18
BLAKE2b-256 66ec3096a14196b84b1846be8721d12ed60ecb3b1f133f90339160119096ce17

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_callouts-1.0.1-py3-none-any.whl:

Publisher: build-deploy.yml on GooRoo/obsidian-callouts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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