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.0.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.0-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: obsidian_callouts-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2e4d81e3c668dbbd1ae1d5e99dcaf636a0c3fbdbd726680f3ff62217dfe503b8
MD5 a0bb9b3295876e5d2e3663de0370f85f
BLAKE2b-256 81343c7e0c6e58bc6b11d580153d58f3a98a5149a1ea181e5882a9d154cc6956

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_callouts-1.0.0.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.0-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_callouts-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f6d96344a71c91dfa44e834d3ee94b1858c2af9d88982cd11ad253e1d9774af
MD5 07026c5d09b4bca9577a17a0cb0afb55
BLAKE2b-256 58ff327f71e3e9bf70f0d0a68f278db39cbee2417cdbbfbfa0154e02a630c2b5

See more details on using hashes here.

Provenance

The following attestation bundles were made for obsidian_callouts-1.0.0-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