Skip to main content

Convert Obsidian-flavoured markdown to HTML

Project description

obsidian2html

Convert Obsidian-flavoured markdown to HTML.

Installation

pip install obsidian2html

Usage

On the command line:

obsidian2html infile outfile

As a python library:

from obsidian2html import obsidian2html

src = '''
# A simple markdown file

Hello world!
'''

html: str = obsidian2html(src)

print(html)

Features

  • Convert internal links:
    [[my notes|Notes]] -> <a href="Notes.html">my notes</a>
    [[a non-obsidian-markdown link|example.pdf]] -> <a href="example.pdf">a non-obsidian-markdown link</a>
    
    

Missing features

Basics:

Advanced:

  • callouts
  • MathJAX
  • Tables
  • mermaid diagrams

References

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

obsidian2html-0.1.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

obsidian2html-0.1.1-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file obsidian2html-0.1.1.tar.gz.

File metadata

  • Download URL: obsidian2html-0.1.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for obsidian2html-0.1.1.tar.gz
Algorithm Hash digest
SHA256 2b8fe901a7325c98a45b42186e8afbee42c9e00790746437436bfcfe75c506c8
MD5 77d80436ecaba93deb27831adc0d77bb
BLAKE2b-256 a5f41834ef44e84e8ef8bd479466d0e455828e637375047ba4bc70c6573cf326

See more details on using hashes here.

File details

Details for the file obsidian2html-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian2html-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 98dc088614730cbef31af9424900de7d7ee7213305b9d6b946c0d45e4d491528
MD5 a20d2582f400fbfad708850d17bba8cc
BLAKE2b-256 91d831ebaa9b0d103140bfa1d22de1c2d91bc77279ddacae2feae3ee508dab3d

See more details on using hashes here.

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