@mazhu/mdserver
v1.0.0
Published
Local Markdown preview server with live reload
Maintainers
Readme
@mazhu/mdserver
Local Markdown preview server with live reload
Features
- 🚀 Instant Preview - Preview Markdown files in your browser
- 🔄 Live Reload - Auto-refresh when files change via WebSocket
- 📂 File Watching - Monitor specific files for changes
- 🎨 Beautiful Styling - Clean, readable output with syntax highlighting
- 🌐 WebSocket Powered - Real-time communication between server and browser
Installation
npm install -g @mazhu/mdserverUsage
Start the server
mdserver startPreview a specific file
mdserver start readme.mdOpen browser (when server is running)
mdserver openWatch a file for changes
mdserver watch readme.mdCommands
| Command | Description |
|---------|-------------|
| mdserver start [file] | Start the preview server, optionally with a file |
| mdserver open | Open the preview in browser |
| mdserver watch [file] | Watch a file and auto-reload |
| mdserver --version | Show version |
| mdserver --help | Show help |
API
Endpoints
GET /- Root pageGET /file?path=<path>- Preview specific fileGET /open?file=<path>- Load file and notify all clients
WebSocket Events
content- File content updatereload- Trigger page reload
License
MIT
