A zero-config CLI tool to preview your local Markdown files in a browser. npx mdts
— and you're done.
- ⚡ Instant Markdown Preview – Run and view in seconds
- 🌐 Web UI – Clean, tree-based browser interface
- 🔄 Live Reload – Automatically refreshes on file changes
- 🧘 Zero Setup – No config, no install, no nonsense
npx mdts
This starts a local server at http://localhost:8521 and opens your browser. Your current directory becomes a browsable Markdown tree.
- Reviewing AI-generated docs
- Quickly checking README or note folders
- Lightweight local Markdown wiki
- Node.js
- No installation needed – uses
npx
npx mdts <directory> --host 0.0.0.0 --port 3000 --silent
Option | Description | Example |
---|---|---|
<directory> |
Specify root directory (default .) | ./docs |
--host |
Host to listen on (default localhost) | 0.0.0.0 |
--port |
Change the server port (default 8521) | 8000 |
--silent |
Suppress server logs | false |
Found a bug? Have an idea? Want to send a PR?
See CONTRIBUTING.md for details — we'd love to have your help!