A local markdown preview server. npx mdts — and you're done.
翻譯準備中
正在載入完整 README。
檢視完整 README ↗npx mdts
This starts a local server at http://localhost:8521 and opens your browser. Your current directory becomes a browsable Markdown tree.
See detailed use cases for more examples and workflows.
npxnpx mdts [directory] [options]
| Option | Description | Example |
|---|---|---|
[directory] | Directory to serve (default .) | ./docs |
--glob, -g | Glob patterns to filter markdown files | -g 'docs/*.md' 'specs/*.md' |
--host, -H | Host to listen on (default localhost) | 0.0.0.0 |
--port, -p | Port to serve on (default 8521) | 8000 |
--silent, -s | Suppress server logs (default false) | |
--no-open | Do not open the browser automatically | |
--version, -V | Output version number | |
--help, -h | Display help for command |
# Serve current directory (all markdown files)
npx mdts
# Serve a specific directory
npx mdts ./docs
# Filter with glob patterns (only matching files are shown)
npx mdts ./project -g 'docs/**/*.md' 'README.md'
# Combine options
npx mdts ./monorepo -g 'packages/*/README.md' --port 3000 --no-open
Experience mdts in action with real examples and interactive features.
Found a bug? Have an idea? Want to send a PR?
See CONTRIBUTING.md for details — we'd love to have your help!
If you find this project useful, please consider:
Every bit of support helps. Thanks!