https://github.com/unhappychoice/mdts
A local markdown preview server. npx mdts — and you're done.
https://github.com/unhappychoice/mdts
cli filesystem frontmatter live-reload markdown markdown-renderer mermaid preview server webui zero-setup zero-setup-tools
Last synced: 5 months ago
JSON representation
A local markdown preview server. npx mdts — and you're done.
- Host: GitHub
- URL: https://github.com/unhappychoice/mdts
- Owner: unhappychoice
- License: mit
- Created: 2025-07-13T09:59:58.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-08-13T05:55:03.000Z (5 months ago)
- Last Synced: 2025-08-13T07:18:40.188Z (5 months ago)
- Topics: cli, filesystem, frontmatter, live-reload, markdown, markdown-renderer, mermaid, preview, server, webui, zero-setup, zero-setup-tools
- Language: TypeScript
- Homepage: https://mdts.unhappychoice.com
- Size: 5.74 MB
- Stars: 69
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
**A zero-config CLI tool to preview your local Markdown files in a browser.** **`npx mdts` — and you're done.**
## 🔧 Features
- ⚡ **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
## 🚀 Quick Start
```bash
npx mdts
```
This starts a local server at http://localhost:8521 and opens your browser.
Your current directory becomes a browsable Markdown tree.
## 💡 Use Cases
- Reviewing AI-generated docs
- Quickly checking README or note folders
- Lightweight local Markdown wiki
## 📦 Requirements
- Node.js
- No installation needed – uses `npx`
## 🛠 Options
```bash
npx mdts --host 0.0.0.0 --port 3000 --silent
```
| Option | Description | Example |
| -------------- | ------------------------------------- |---------|
| `` | 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 |
## 📚 Documentation
- [Use Cases](docs/usecases.md)
- [Markdown Features](docs/markdown_features.md)
- [Frontend Features](docs/frontend_features.md)
- [Screenshots](docs/screenshots.md)
- [Comparison with other tools](docs/comparison.md)
- [FAQ](docs/faq.md)
## Contributing
Found a bug? Have an idea? Want to send a PR?
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details — we'd love to have your help!