Metadata-Version: 2.4
Name: markdown-live-server
Version: 0.1.1
Summary: Markdown live server with live reload using Pandoc
License: MIT
Project-URL: Homepage, https://github.com/mfyz/mdv
Project-URL: Repository, https://github.com/mfyz/mdv
Keywords: markdown,pandoc,live-reload,server
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bottle
Dynamic: license-file

# 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

```bash
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)

```bash
mdv file.md
```

### Server Mode (web browser)

```bash
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](http://pandoc.org/) by [Marcel Fischer](http://marcelfischer.eu/).

## License

MIT
