mdts 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 unhappychoice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,57 @@
+<h1 align="center">
+  <img src="docs/logo.svg" alt="mdts" width="400">
+</h1>
+
+`mdts` (MarkDown Tree Server) is a simple command-line tool that serves Markdown files from a specified local directory and provides a web-based interface to browse and view them. It automatically opens the served content in your default web browser.
+
+## Features
+
+- **File Tree Navigation**: Provides a hierarchical view of your Markdown files for easy browsing.
+- **Markdown Rendering**: Renders Markdown files in a clean, readable format.
+- [WIP] **Live Reload**: 
+
+![screenshot](docs/screenshot.png)
+
+
+## Usage
+```bash
+npx mdts
+```
+
+By default, `mdts` will serve files from the current directory (`.`) on port `8521`. It will automatically open a new tab in your web browser pointing to `http://localhost:8521`.
+
+### Options
+
+You can specify a different directory and port:
+
+```bash
+npx mdts [directory] --port 8000
+```
+
+-   `-p, --port <port>`: Specify the port to serve on (default: `8521`)
+-   `[directory]`: Specify the directory to serve (default: current directory `.`)
+
+**Example:**
+
+To serve Markdown files from the `docs` directory on port `3000`:
+
+```bash
+npx mdts docs -p 3000
+```
+
+## Development
+
+To build the project:
+
+```bash
+npm run build & npm run build:frontend
+```
+
+To start the server:
+```bash
+npm start
+```
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

package/dist/cli.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cli = void 0;
+const server_1 = require("./server");
+const open_1 = __importDefault(require("open"));
+const commander_1 = require("commander");
+const DEFAULT_PORT = 8521;
+const DEFAULT_DIRECTORY = '.';
+const cli = () => {
+    const program = new commander_1.Command();
+    program
+        .option('-p, --port <port>', 'Port to serve on', String(DEFAULT_PORT))
+        .argument('[directory]', 'Directory to serve', DEFAULT_DIRECTORY)
+        .action((directory, options) => {
+        const port = parseInt(options.port, 10);
+        (0, server_1.serve)(directory, port);
+        (0, open_1.default)(`http://localhost:${port}`);
+    });
+    program.parse(process.argv);
+};
+exports.cli = cli;

package/dist/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("./cli");
+(0, cli_1.cli)();

package/dist/server.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serve = void 0;
+const express_1 = __importDefault(require("express"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const serve = (directory, port) => {
+    const app = (0, express_1.default)();
+    app.use(express_1.default.static('public'));
+    app.use(express_1.default.static('dist/frontend'));
+    app.get('/filetree', (req, res) => {
+        res.json(getFileTree(directory, '')); // Pass empty string as initial relative path
+    });
+    app.use('/content', express_1.default.static(directory));
+    // Catch-all route to serve index.html for any other requests
+    app.get('*', (req, res) => {
+        res.sendFile(path_1.default.join(__dirname, '../public/index.html'));
+    });
+    app.listen(port, () => {
+        console.log(`Server listening at http://localhost:${port}`);
+    });
+};
+exports.serve = serve;
+const getFileTree = (baseDirectory, currentRelativePath) => fs_1.default.readdirSync(path_1.default.join(baseDirectory, currentRelativePath), { withFileTypes: true })
+    .map((entry) => {
+    const entryPath = path_1.default.join(currentRelativePath, entry.name);
+    return entry.isDirectory()
+        ? { [entry.name]: getFileTree(baseDirectory, entryPath) }
+        : entryPath; // Return full relative path for files
+});

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "mdts",
+  "version": "0.1.0",
+  "description": "A markdown preview server.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "mdts": "./bin/mdts"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "start": "npm run build:frontend && npm run build && node dist/index.js",
+    "build:frontend": "webpack --config webpack.config.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unhappychoice/mdts.git"
+  },
+  "keywords": [
+    "markdown",
+    "preview",
+    "server",
+    "cli",
+    "live-reload"
+  ],
+  "author": "unhappychoice",
+  "license": "MIT",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/unhappychoice/mdts/issues"
+  },
+  "homepage": "https://github.com/unhappychoice/mdts#readme",
+  "devDependencies": {
+    "@babel/core": "^7.28.0",
+    "@babel/preset-env": "^7.28.0",
+    "@babel/preset-react": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
+    "@emotion/react": "^11.11.4",
+    "@emotion/styled": "^11.11.5",
+    "@mui/material": "^7.2.0",
+    "@types/commander": "^2.12.0",
+    "@types/express": "^4.17.21",
+    "@types/markdown-it": "^14.1.2",
+    "@types/react": "^19.1.8",
+    "@types/react-dom": "^19.1.6",
+    "babel-loader": "^10.0.0",
+    "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"
+  },
+  "dependencies": {
+    "@mui/icons-material": "^7.2.0",
+    "@mui/x-tree-view": "^8.8.0",
+    "commander": "^14.0.0",
+    "express": "^4.19.2",
+    "open": "^10.1.2",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "react-markdown": "^10.1.0",
+    "remark-gfm": "^4.0.1"
+  }
+}