Skip to main content

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

Installation

pipx install markdown-live-server

Requirements

  • pandoc (required) - Markdown/RST to HTML converter
  • graphviz (optional) - For rendering dot diagrams
  • plantuml (optional) - For rendering PlantUML diagrams

Usage

CLI Mode (terminal output)

mdv file.md

Server Mode (web browser)

mdv                    # Start server in current directory
mdv /path/to/docs      # Start server in specific directory
mdv -a -b              # Auto-refresh + open browser

Options

  • -a Enable auto-refresh (live reload)
  • -b Open browser automatically
  • -r Allow remote connections (bind to all interfaces)
  • -p PORT Port number (default: 8080)

Attribution

Based on Panserver by Marcel Fischer.

License

MIT

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

markdown_live_server-0.1.1.tar.gz (9.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

markdown_live_server-0.1.1-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: markdown_live_server-0.1.1.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

Hashes for markdown_live_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0b74929bb014d6370dad342678bd8779da9887b74563a20d97f0af5be276bf69
MD5 fc4333ca873993d2b344c805eb8e5a84
BLAKE2b-256 c81a4be492729a2ac576cc36d72f92e7f646ea7288115d3af5d7d0e166d75dc8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_live_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6e5b96863cedf830ffa01f76dc5b391f576c1e1a35d785c6be76c2c259503099
MD5 530d3cd1ccd1a745ad47472ac3246d96
BLAKE2b-256 97eef6887f32df7fc64994f5e4172bdcdbd7f969355187fa50618f10e5284695

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page