mdts 0.2.0 → 0.3.1

package/dist/server/routes/outline.js

@@ -1,8 +1,11 @@
 import { Router } from 'express';
 import fs from 'fs';
-import path from 'path';
 import MarkdownIt from 'markdown-it';
+import path, { dirname } from 'path';
+import { fileURLToPath } from 'url';
 const md = new MarkdownIt();
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
 const slugify = (text) => {
     return text
         .toLowerCase()
@@ -36,7 +39,9 @@ export const outlineRouter = (directory) => {
             return res.status(400).send('filePath query parameter is required.');
         }
         try {
-            const absolutePath = path.join(directory, filePath);
+            const absolutePath = filePath === 'mdts-welcome-markdown.md'
+                ? path.join(__dirname, '../../../public/welcome.md')
+                : path.join(directory, filePath);
             const outline = getMarkdownOutline(absolutePath);
             res.json(outline);
         }

package/dist/server/server.js

@@ -1,23 +1,74 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import chokidar from 'chokidar';
 import express from 'express';
-import path from 'path';
+import { promises as fs } from 'fs';
+import path, { dirname } from 'path';
 import { fileURLToPath } from 'url';
-import { dirname } from 'path';
+import { WebSocketServer } from 'ws';
 import { fileTreeRouter } from './routes/filetree.js';
 import { outlineRouter } from './routes/outline.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 export const serve = (directory, port) => {
     const app = express();
+    // Mount library static files
     app.use(express.static(path.join(__dirname, '../../public')));
     app.use(express.static(path.join(__dirname, '../../dist/frontend')));
-    app.use('/content', express.static(directory));
+    // Define API
     app.use('/api/filetree', fileTreeRouter(directory));
+    app.get('/api/markdown/mdts-welcome-markdown.md', (req, res) => {
+        res.setHeader('Content-Type', 'text/plain');
+        res.sendFile(path.join(__dirname, '../../public/welcome.md'));
+    });
+    app.use('/api/markdown', express.static(directory));
     app.use('/api/outline', outlineRouter(directory));
     // Catch-all route to serve index.html for any other requests
-    app.get('*', (req, res) => {
-        res.sendFile(path.join(__dirname, '../../public/index.html'));
-    });
-    app.listen(port, () => {
+    app.get('*', (req, res) => __awaiter(void 0, void 0, void 0, function* () {
+        const filePath = path.join(directory, req.path);
+        let isDirectory = false;
+        try {
+            const stats = yield fs.stat(filePath);
+            isDirectory = stats.isDirectory();
+        }
+        catch (error) {
+            // File or directory does not exist, proceed as if it's a file
+        }
+        if (isDirectory || req.path.toLowerCase().endsWith('.md') || req.path.toLowerCase().endsWith('.markdown')) {
+            return res.sendFile(path.join(__dirname, '../../public/index.html'));
+        }
+        else {
+            return res.sendFile(req.path, { root: directory });
+        }
+    }));
+    const server = app.listen(port, () => {
         console.log(`🚀 Server listening at http://localhost:${port}`);
     });
+    const wss = new WebSocketServer({ server });
+    const watcher = chokidar.watch(directory, { ignored: /node_modules/, ignoreInitial: true });
+    watcher.on('change', (filePath) => {
+        console.log(`🔃 File changed: ${filePath}, reloading...`);
+        wss.clients.forEach((client) => {
+            client.send(JSON.stringify({ type: 'reload-content' }));
+        });
+    });
+    watcher.on('add', (filePath) => {
+        console.log(`🌲 File added: ${filePath}, reloading tree...`);
+        wss.clients.forEach((client) => {
+            client.send(JSON.stringify({ type: 'reload-tree' }));
+        });
+    });
+    watcher.on('unlink', (filePath) => {
+        console.log('🌲 File removed: ${filePath}, reloading tree...');
+        wss.clients.forEach((client) => {
+            client.send(JSON.stringify({ type: 'reload-tree' }));
+        });
+    });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdts",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "A markdown preview server.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,6 +48,7 @@
     "@types/markdown-it": "^14.1.2",
     "@types/react": "^19.1.8",
     "@types/react-dom": "^19.1.6",
+    "@types/ws": "^8.18.1",
     "babel-loader": "^10.0.0",
     "css-loader": "^7.1.2",
     "html-webpack-plugin": "^5.6.3",
@@ -60,6 +61,7 @@
   "dependencies": {
     "@mui/icons-material": "^7.2.0",
     "@mui/x-tree-view": "^8.8.0",
+    "chokidar": "^4.0.3",
     "commander": "^14.0.0",
     "express": "^4.19.2",
     "markdown-it": "^14.1.0",
@@ -68,6 +70,9 @@
     "react-dom": "^19.1.0",
     "react-markdown": "^10.1.0",
     "remark-gfm": "^4.0.1",
-    "remark-slug": "^7.0.1"
+    "remark-slug": "^7.0.1",
+    "rehype-raw": "^7.0.0",
+    "react-syntax-highlighter": "^15.6.1",
+    "ws": "^8.18.3"
   }
 }

package/public/welcome.md

@@ -0,0 +1,31 @@
+<h1 align="center">
+  <img src="logo.svg" alt="mdts" width="400">
+</h1>
+
+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.
+*   **Dark Mode:** Supports dark mode for comfortable reading.
+
+## Usage
+
+To start the mdts server, run:
+
+```bash
+mdts <path_to_your_markdown_directory>
+```
+
+Then, open your browser and navigate to `http://localhost:<port>` (default port is 8521).
+
+## 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.
+
+## Links
+
+*   [GitHub Repository](https://github.com/unhappychoice/mdts)