mdts
TypeScript icon, indicating that this package has built-in type declarations

0.8.2 • Public • Published

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

Package Sidebar

Install

npm i mdts

Weekly Downloads

592

Version

0.8.2

License

MIT

Unpacked Size

15.6 MB

Total Files

60

Last publish

Collaborators

  • unhappychoice