live web preview of markdown docs
Project description
Markdown Live Preview
Features
-
Live Preview: Updates preview on file save
-
Auto Follow: Focus on edited element
-
Syntax Highlight: Automatically use
highlightjs
ifnode
is available -
Github flavoured: Looks familiar
Preview
The animation is only choppy because it's a compressed gif.
Usage
mlp <name of markdown>
Flags | Flags |
---|---|
-p, --port PORT=8080 |
Port to use |
-o, --open |
No localhost restriction |
--nf, --no-follow |
Do not follow edits |
--nf, --no-browser |
Do not open browser |
Install
pip install -U markdown_live_preview
Embedding
Markdown Live Preview (MLP) can be embedded into other applications as a subprocess.
The flag --read-stdin
is designed such that MLP can read markdown chunks from nul delimited stdin, and process them accordingly.
Future Improvements
Currently the "reconciliation" stage uses a single pass O(n)
naive algorithm.
This does not recognize row insertion / deletion / rotation. As a result, we have some issues with some false highlights.
A more sophisticated colouring algorithm is required.
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
Built Distribution
Hashes for markdown-live-preview-0.1.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16129bc7714d954b1d4fc4211cc57192b95e9d9ac38e7702d9a5796874da0d01 |
|
MD5 | 5a87d1186ee8178abb507678e592afbc |
|
BLAKE2b-256 | a3493f479be6fa45c128f43c11ffe19cf9108183ca35bcc126beb180ca19cbe1 |
Hashes for markdown_live_preview-0.1.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1df299145222e3e6021ab08c53147b43e9a22275883411b670f1e403c420e27f |
|
MD5 | a4b29dad6f8b22e7a58218e4c1ab9ab0 |
|
BLAKE2b-256 | d41e84cf9a1116d6c9aac7247ddf564f5f4c157d708dd3d18739db15d33aedb1 |