Markdown live server with live reload using Pandoc
Project description
Markdown Live Server (mdv)
A local markdown server with live reload using Pandoc. Changes are detected automatically!
Features
- Live reload when files change
- Table of contents generation
- Dark mode support
- Code syntax highlighting
- Graphviz diagram rendering
- PlantUML diagram rendering
Requirements
Python packages (pip install):
- bottle - Web framework
External programs (system install):
- pandoc - REQUIRED: Markdown/RST to HTML converter
- graphviz - OPTIONAL: For rendering 'dot' diagrams
- plantuml - OPTIONAL: For rendering PlantUML diagrams
Termux installation
pkg install pandoc graphviz
pip install bottle
Usage
CLI Mode (terminal output)
./mdv.sh file.md
Server Mode (web browser)
./mdv.sh
Or with options:
python panserver.py [path] [-p PORT] [-a] [-b] [-r]
-aEnable auto-refresh (live reload)-bOpen browser automatically-rAllow remote connections (bind to all interfaces)-pPort number (default: 8080)
Attribution
Based on Panserver by Marcel Fischer.
License
MIT License
Copyright (c) 2025
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdown_live_server-0.1.0.tar.gz.
File metadata
- Download URL: markdown_live_server-0.1.0.tar.gz
- Upload date:
- Size: 9.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8edae00a3934677e417df0830e866405fcb7d9445e5e9f450b3a05839f9c52a2
|
|
| MD5 |
0f4d7769d175f12673059d1850979193
|
|
| BLAKE2b-256 |
888c2b5403c15c1c48b8ddbad736a67e08e1c024d3b82a5d9eae4ce235d14bc2
|
File details
Details for the file markdown_live_server-0.1.0-py3-none-any.whl.
File metadata
- Download URL: markdown_live_server-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
165d066d77611870b28e4a489e117db0c133ffd6b86ada14f9f7c57d1767be25
|
|
| MD5 |
9cae343b2bfdb53fcaef195dc7556092
|
|
| BLAKE2b-256 |
646572207ec3387fa5210d6146ad1dc98a9ac3bd982710b8ad78bc02fbc943b2
|