Skip to content

A local markdown preview server. npx mdts — and you're done.

License

Notifications You must be signed in to change notification settings

unhappychoice/mdts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4226ad8 · Jul 29, 2025

History

234 Commits
Jul 29, 2025
Jul 16, 2025
Jul 24, 2025
Jul 29, 2025
Jul 18, 2025
Jul 18, 2025
Jul 29, 2025
Jul 29, 2025
Jul 29, 2025
Jul 14, 2025
Jul 26, 2025
Jul 28, 2025
Jul 14, 2025
Jul 28, 2025
Jul 21, 2025
Jul 21, 2025
Jul 21, 2025
Jul 29, 2025
Jul 28, 2025
Jul 16, 2025

Repository files navigation

mdts

A zero-config CLI tool to preview your local Markdown files in a browser. npx mdts — and you're done.

mdts demo

🔧 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

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

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

📚 Documentation

Contributing

Found a bug? Have an idea? Want to send a PR?
See CONTRIBUTING.md for details — we'd love to have your help!