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.19.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24236c058ee94c628370c41259c7abf0fba58d5dddb0760b51f4ee770c9ed5f2 |
|
MD5 | d3dd3a66cdc0e0c06ad538d3e72c5c79 |
|
BLAKE2b-256 | efeecbc6043447724b4463398581f51d78d8a897a2db7c45527ac063ccd5bfc9 |
Hashes for markdown_live_preview-0.1.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab2395384bc12e45b2d224de474a78679362aeeb3bda820c0c643114c9665f52 |
|
MD5 | cc9fb56cc5b269808c17709107d0f28b |
|
BLAKE2b-256 | 1a9fa592804781a445e73c094e4f5199543ec39da6045152767556346ae8d643 |