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:
- Support for checklists - https://codepen.io/ouroboros8/pen/KKOzmBX
- comments
%%this is an obsidian markdown inline comment%%
- footnotes
Advanced:
- callouts
- MathJAX
- Tables
- mermaid diagrams
References
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
obsidian2html-0.1.2.tar.gz
(4.6 kB
view details)
Built Distribution
File details
Details for the file obsidian2html-0.1.2.tar.gz
.
File metadata
- Download URL: obsidian2html-0.1.2.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cc1d52dadc3b74823fe940c9840c5ab1449c8bb1b5d1557d06f6292133e9d9b |
|
MD5 | 6013acaa35dbb7316a233bd128f5a5f9 |
|
BLAKE2b-256 | 877f2dbcb60682d76ac861bf228c55234aca012752f358d77d00ca486c402009 |
File details
Details for the file obsidian2html-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: obsidian2html-0.1.2-py3-none-any.whl
- Upload date:
- Size: 3.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bfb122507e63bd4b725e88861606c2ea4a64698350c7595606f1fa3f5cc746e5 |
|
MD5 | c9053235606288a415280ce2b96eb67f |
|
BLAKE2b-256 | 1fb2c196861789cac678a5b7cb627b102e60ca73a5d04a4406f9f10dde309e78 |