mdts 0.13.0 → 0.14.0

package/README.md

@@ -2,7 +2,17 @@
   <img src="docs/images/logo.svg" alt="mdts" width="400">
 </h1>
 
-**A zero-config CLI tool to preview your local Markdown files in a browser.**  **`npx mdts` — and you're done.**
+<p align="center">
+  A zero-config CLI tool to preview your local Markdown files in a browser.
+  <br>
+  <strong>npx mdts</strong> — and you're done.
+</p>
+
+<p align="center">
+  <a href="https://mdts-unhappychoice.netlify.app" target="_blank">
+    <strong>🔗 Try the Live Demo</strong>
+  </a>
+</p>
 
 <p align="center">
   <img src="docs/images/screen_animation.gif" width="640" alt="mdts demo">
@@ -11,9 +21,10 @@
 ## 🔧 Features
 
 - ⚡ **Instant Markdown Preview** – Run and view in seconds  
-- 🌐 **Web UI** – Clean, tree-based browser interface  
+- 🌐 **Web UI** – Clean, tree-based browser interface with three-panel layout
 - 🔄 **Live Reload** – Automatically refreshes on file changes  
-- 🧘 **Zero Setup** – No config, no install, no nonsense  
+- 🧘 **Zero Setup** – No config, no install, no nonsense
+- 🎨 **Custom Themes** – 20+ beautiful application themes and syntax highlighting options
 
 
 ## 🚀 Quick Start
@@ -31,6 +42,8 @@ Your current directory becomes a browsable Markdown tree.
 - Quickly checking README or note folders  
 - Lightweight local Markdown wiki  
 
+See [detailed use cases](docs/usecases.md) for more examples and workflows.  
+
 ## 📦 Requirements
 
 - Node.js
@@ -42,19 +55,27 @@ Your current directory becomes a browsable Markdown tree.
 npx mdts <directory> --host 0.0.0.0 --port 3000 --silent
 ```
 
-| Option         | Description                           | Example |
-| -------------- | ------------------------------------- |---------| 
-| `<directory>`  | Specify root directory (default .)    | ./docs  |
-| `--host`, `-H` | Host to listen on (default localhost) | 0.0.0.0 |
-| `--port`, `-p` | Change the server port (default 8521) | 8000    |
-| `--silent`, `-s` | Suppress server logs                  |         |
+| Option              | Description                           | Example |
+| ------------------- | ------------------------------------- |---------|
+| `<directory>`       | Directory to serve (default .)       | ./docs  |
+| `--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) |         |
+| `--version`, `-V`   | Output version number                 |         |
+| `--help`, `-h`      | Display help for command              |         |
 
 ## 📚 Documentation
 
+### 🔗 [Live Demo](https://mdts-unhappychoice.netlify.app)
+Experience mdts in action with real examples and interactive features.
+
+### 📖 Documentation
 - [Use Cases](docs/usecases.md)
-- [Markdown Features](docs/markdown_features.md)
+- [Markdown Features](docs/markdown_features.md)  
 - [Frontend Features](docs/frontend_features.md)
-- [Screenshots](docs/screenshots.md)
+- [Advanced Configuration](docs/configuration.md)
+- [API Reference](docs/api.md)
+- [Troubleshooting](docs/troubleshooting.md)
 - [Comparison with other tools](docs/comparison.md)
 - [FAQ](docs/faq.md)