# Welcome to mdts! 🚀

mdts (Markdown Tree Server) is a simple and efficient tool for serving and viewing markdown files with an interactive file tree and outline. It's designed to help you navigate and read your markdown-based documentation or notes with ease.

## ✨ Features

*   **Markdown Rendering:** Renders markdown files into clean, readable HTML.
*   **File Tree Navigation:** Browse your markdown files and directories through an intuitive file tree.
*   **Outline View:** Quickly jump to sections within a markdown file using the generated outline.
*   **Live Reload:** Automatically reloads content when markdown files changes.
*   **Custom Themes:** 20+ beautiful application themes and syntax highlighting options.

## 🚀 Usage

To start the mdts server, run:

```bash
npx mdts <path_to_your_markdown_directory>
```

Then, open your browser and navigate to `http://localhost:<port>` (default port is 8521).

## 📚 Documentation

Explore comprehensive guides and references:

*   **[Documentation](https://github.com/unhappychoice/mdts/tree/main/docs)** - Complete guides and API reference
*   **[Use Cases](https://github.com/unhappychoice/mdts/blob/main/docs/usecases.md)** - Real-world workflows and examples
*   **[Configuration](https://github.com/unhappychoice/mdts/blob/main/docs/configuration.md)** - Advanced customization options
*   **[Troubleshooting](https://github.com/unhappychoice/mdts/blob/main/docs/troubleshooting.md)** - Common issues and solutions
*   **[FAQ](https://github.com/unhappychoice/mdts/blob/main/docs/faq.md)** - Frequently asked questions

## 🔗 Links

*   **[GitHub Repository](https://github.com/unhappychoice/mdts)** - Source code and issues
*   **[Live Demo](https://mdts-unhappychoice.netlify.app)** - Try mdts online with example documents
*   **[npm Package](https://www.npmjs.com/package/mdts)** - Install via npm

## ℹ️ About This Page

This is a dynamically generated welcome page. You can replace it with your own `README.md` or any other markdown file by navigating to its path in the URL.
