mdts 0.1.7 → 0.3.0

package/dist/server/routes/filetree.js

@@ -0,0 +1,35 @@
+import { Router } from 'express';
+import fs from 'fs';
+import path from 'path';
+const isDotFileOrDirectory = (entryName) => {
+    return entryName.startsWith('.');
+};
+const isLibraryDirectory = (entryName) => {
+    const libraryDirs = ['node_modules', 'vendor', 'bundle', 'venv', 'env', 'site-packages'];
+    return libraryDirs.includes(entryName);
+};
+const getFileTree = (baseDirectory, currentRelativePath) => {
+    const entries = fs.readdirSync(path.join(baseDirectory, currentRelativePath), { withFileTypes: true })
+        .filter(entry => !isDotFileOrDirectory(entry.name) && !isLibraryDirectory(entry.name));
+    const tree = [];
+    for (const entry of entries) {
+        const entryPath = path.join(currentRelativePath, entry.name);
+        if (entry.isDirectory()) {
+            const subTree = getFileTree(baseDirectory, entryPath);
+            if (subTree.length > 0) { // Only include directory if it contains markdown files
+                tree.push({ [entry.name]: subTree });
+            }
+        }
+        else if (entry.name.endsWith('.md') || entry.name.endsWith('.markdown')) {
+            tree.push(entryPath);
+        }
+    }
+    return tree;
+};
+export const fileTreeRouter = (directory) => {
+    const router = Router();
+    router.get('/', (req, res) => {
+        res.json(getFileTree(directory, ''));
+    });
+    return router;
+};

package/dist/server/routes/outline.js

@@ -0,0 +1,54 @@
+import { Router } from 'express';
+import fs from 'fs';
+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()
+        .replace(/[^\p{L}\p{N}\s-]/gu, '') // Remove non-alphanumeric, non-space, non-hyphen characters. \p{L} for unicode letters, \p{N} for unicode numbers. 'u' flag for unicode.
+        .replace(/\s+/g, '-') // Replace spaces with single hyphen
+        .replace(/-+/g, '-') // Replace multiple hyphens with single hyphen
+        .replace(/^-+|-+$/g, ''); // Trim leading/trailing hyphens
+};
+const getMarkdownOutline = (filePath) => {
+    const fileContent = fs.readFileSync(filePath, 'utf-8');
+    const tokens = md.parse(fileContent, {});
+    const outline = [];
+    for (const token of tokens) {
+        if (token.type === 'heading_open') {
+            const level = parseInt(token.tag.substring(1));
+            const nextToken = tokens[tokens.indexOf(token) + 1];
+            if (nextToken && nextToken.type === 'inline') {
+                const content = nextToken.content;
+                const id = slugify(content);
+                outline.push({ level, content, id });
+            }
+        }
+    }
+    return outline;
+};
+export const outlineRouter = (directory) => {
+    const router = Router();
+    router.get('/', (req, res) => {
+        const filePath = req.query.filePath;
+        if (!filePath) {
+            return res.status(400).send('filePath query parameter is required.');
+        }
+        try {
+            const absolutePath = filePath === 'mdts-welcome-markdown.md'
+                ? path.join(__dirname, '../../../public/welcome.md')
+                : path.join(directory, filePath);
+            const outline = getMarkdownOutline(absolutePath);
+            res.json(outline);
+        }
+        catch (error) {
+            console.error(`Error getting outline for ${filePath}:`, error);
+            res.status(500).send('Error getting outline.');
+        }
+    });
+    return router;
+};

package/dist/server/server.js

@@ -0,0 +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 { promises as fs } from 'fs';
+import path, { dirname } from 'path';
+import { fileURLToPath } from 'url';
+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')));
+    // 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) => __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.1.7",
+  "version": "0.3.0",
   "description": "A markdown preview server.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -48,24 +48,31 @@
     "@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",
+    "chokidar": "^4.0.3",
     "css-loader": "^7.1.2",
     "html-webpack-plugin": "^5.6.3",
     "style-loader": "^4.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.8.3",
     "webpack": "^5.100.1",
-    "webpack-cli": "^6.0.1"
+    "webpack-cli": "^6.0.1",
+    "ws": "^8.18.3"
   },
   "dependencies": {
     "@mui/icons-material": "^7.2.0",
     "@mui/x-tree-view": "^8.8.0",
     "commander": "^14.0.0",
     "express": "^4.19.2",
+    "markdown-it": "^14.1.0",
     "open": "^10.1.2",
     "react": "^19.1.0",
     "react-dom": "^19.1.0",
     "react-markdown": "^10.1.0",
-    "remark-gfm": "^4.0.1"
+    "remark-gfm": "^4.0.1",
+    "remark-slug": "^7.0.1",
+    "rehype-raw": "^7.0.0",
+    "react-syntax-highlighter": "^15.6.1"
   }
 }

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)

package/dist/server.js

@@ -1,30 +0,0 @@
-import express from 'express';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { dirname } from 'path';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
-export const serve = (directory, port) => {
-    const app = express();
-    app.use(express.static(path.join(__dirname, '../public')));
-    app.use(express.static(path.join(__dirname, '../dist/frontend')));
-    app.get('/filetree', (req, res) => {
-        res.json(getFileTree(directory, '')); // Pass empty string as initial relative path
-    });
-    app.use('/content', express.static(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, () => {
-        console.log(`Server listening at http://localhost:${port}`);
-    });
-};
-const getFileTree = (baseDirectory, currentRelativePath) => fs.readdirSync(path.join(baseDirectory, currentRelativePath), { withFileTypes: true })
-    .map((entry) => {
-    const entryPath = path.join(currentRelativePath, entry.name);
-    return entry.isDirectory()
-        ? { [entry.name]: getFileTree(baseDirectory, entryPath) }
-        : entryPath; // Return full relative path for files
-});