@tdocs/tdocs 1.0.0

package/build/compiler.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compileMarkdown = compileMarkdown;
+const marked_1 = require("marked");
+const marked_highlight_1 = require("marked-highlight");
+const highlight_js_1 = __importDefault(require("highlight.js"));
+marked_1.marked.use((0, marked_highlight_1.markedHighlight)({
+    langPrefix: 'hljs language-',
+    highlight(code, lang) {
+        const language = highlight_js_1.default.getLanguage(lang) ? lang : 'plaintext';
+        return highlight_js_1.default.highlight(code, { language }).value;
+    }
+}));
+// Phase 2: Markdown Compilation
+// This module will iterate through the AST and transform raw Markdown strings into valid HTML strings.
+function compileMarkdown(ast) {
+    // Recursively compile markdown content to html
+    function compileNode(node) {
+        if (node.markdownContent) {
+            node.htmlContent = marked_1.marked.parse(node.markdownContent);
+        }
+        else {
+            node.htmlContent = '';
+        }
+        if (node.children && node.children.length > 0) {
+            node.children.forEach(compileNode);
+        }
+    }
+    ast.tree.forEach(compileNode);
+    return ast; // Return mutablility-modified AST
+}

package/build/generator.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateStaticSite = generateStaticSite;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const ejs_1 = __importDefault(require("ejs"));
+// Phase 3: Static Site Generation (Rendering)
+// This module will take the compiled AST and inject it into UI templates.
+async function generateStaticSite(ast, destDir = './dist') {
+    // 1. Ensure dest exists
+    if (!fs_1.default.existsSync(destDir)) {
+        fs_1.default.mkdirSync(destDir, { recursive: true });
+    }
+    // 2. Read template and render
+    const templatePath = path_1.default.join(__dirname, '../templates/layout.ejs');
+    const templateStr = fs_1.default.readFileSync(templatePath, 'utf8');
+    const htmlOutput = ejs_1.default.render(templateStr, {
+        config: ast.config,
+        tree: ast.tree,
+        serializeTree: (nodes) => JSON.stringify(nodes) // Pass the AST to the client to render content dynamically
+    });
+    // 3. Write index.html
+    fs_1.default.writeFileSync(path_1.default.join(destDir, 'index.html'), htmlOutput);
+    // 4. Copy CSS
+    const cssPath = path_1.default.join(__dirname, '../templates/style.css');
+    if (fs_1.default.existsSync(cssPath)) {
+        fs_1.default.copyFileSync(cssPath, path_1.default.join(destDir, 'style.css'));
+    }
+    // 5. Copy user assets if specified
+    if (ast.config && ast.config.assets) {
+        const assetsSrcPath = path_1.default.resolve(ast.config.assets);
+        if (fs_1.default.existsSync(assetsSrcPath)) {
+            const assetsDestPath = path_1.default.join(destDir, path_1.default.basename(assetsSrcPath));
+            fs_1.default.cpSync(assetsSrcPath, assetsDestPath, { recursive: true });
+            console.log(`Copied assets from ${assetsSrcPath} to ${assetsDestPath}`);
+        }
+        else {
+            console.warn(`Asset folder not found: ${assetsSrcPath}`);
+        }
+    }
+    console.log(`Generated documentation at ${destDir}`);
+}

package/build/index.js

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const chokidar_1 = __importDefault(require("chokidar"));
+const parser_1 = require("./parser");
+const compiler_1 = require("./compiler");
+const generator_1 = require("./generator");
+const program = new commander_1.Command();
+program
+    .name('tdoc')
+    .description('A custom Static Site Generator for rapid documentation prototyping.')
+    .version('1.0.0');
+async function build(file, outDir = './dist') {
+    try {
+        const ast = (0, parser_1.parseTDoc)(file);
+        const compiledAst = (0, compiler_1.compileMarkdown)(ast);
+        await (0, generator_1.generateStaticSite)(compiledAst, outDir);
+    }
+    catch (error) {
+        console.error('Error during build:', error);
+    }
+}
+program
+    .command('build')
+    .description('Compile a .tdoc file into a static documentation site')
+    .argument('<file>', 'The .tdoc file to compile')
+    .option('-o, --out <dir>', 'Output directory', './dist')
+    .action((file, options) => {
+    console.log(`Building site from ${file}...`);
+    build(file, options.out);
+});
+const browser_sync_1 = __importDefault(require("browser-sync"));
+// ... (in watch command)
+program
+    .command('watch')
+    .description('Watch for changes on a .tdoc file and hot-reload')
+    .argument('<file>', 'The .tdoc file to watch')
+    .option('-o, --out <dir>', 'Output directory', './dist')
+    .action(async (file, options) => {
+    console.log(`Watching ${file} for changes...`);
+    // Initial build
+    await build(file, options.out);
+    // Initialize BrowserSync
+    const bsInstance = browser_sync_1.default.create();
+    bsInstance.init({
+        server: {
+            baseDir: options.out
+        },
+        open: true,
+        notify: false
+    });
+    chokidar_1.default.watch(file).on('change', async () => {
+        console.log(`\nFile ${file} changed. Rebuilding...`);
+        await build(file, options.out);
+        bsInstance.reload();
+    });
+});
+program.parse();

package/build/parser.js

@@ -0,0 +1,99 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTDoc = parseTDoc;
+const fs_1 = __importDefault(require("fs"));
+// The config is simple key-value pairs, let's parse it manually.
+function parseTDoc(filePath) {
+    const fileContent = fs_1.default.readFileSync(filePath, 'utf-8');
+    let config = {};
+    let rawBody = fileContent;
+    if (fileContent.startsWith('@config')) {
+        const endConfigIdx = fileContent.indexOf('---');
+        if (endConfigIdx !== -1) {
+            const configBlock = fileContent.substring('@config'.length, endConfigIdx).trim();
+            rawBody = fileContent.substring(endConfigIdx + 3).trim();
+            // Parse key: value
+            const configLines = configBlock.split('\n');
+            for (const line of configLines) {
+                const colonIdx = line.indexOf(':');
+                if (colonIdx !== -1) {
+                    const key = line.substring(0, colonIdx).trim();
+                    let val = line.substring(colonIdx + 1).trim();
+                    // remove surrounding quotes if any
+                    if (val.startsWith('"') && val.endsWith('"'))
+                        val = val.substring(1, val.length - 1);
+                    if (val.startsWith("'") && val.endsWith("'"))
+                        val = val.substring(1, val.length - 1);
+                    config[key] = val;
+                }
+            }
+        }
+    }
+    // 2. Parse structural markers and markdown content
+    const tree = buildTree(rawBody);
+    return {
+        config,
+        tree
+    };
+}
+function buildTree(content) {
+    const lines = content.split('\n');
+    const rootNodes = [];
+    const stack = []; // Stack to keep track of parent hierarchy based on indentation
+    let currentNode = null;
+    const markerRegex = /^(\s*)\[(.*?)\]\s*$/;
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        const match = line.match(markerRegex);
+        if (match) {
+            // It's a structural marker
+            const indentStr = match[1];
+            const title = match[2];
+            const level = indentStr.length;
+            const newNode = {
+                id: title.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/(^-|-$)/g, ''),
+                title: title,
+                markdownContent: '',
+                children: [],
+                level: level
+            };
+            // Determine parent based on indentation level
+            while (stack.length > 0 && stack[stack.length - 1].level >= level) {
+                stack.pop(); // Pop nodes that are siblings or deeper
+            }
+            if (stack.length > 0) {
+                // We found a parent
+                stack[stack.length - 1].children.push(newNode);
+            }
+            else {
+                // It's a root node
+                rootNodes.push(newNode);
+            }
+            // Make this the current node to append markdown to and push to stack
+            currentNode = newNode;
+            stack.push(currentNode);
+        }
+        else {
+            // It's markdown content belonging to the current node
+            if (currentNode) {
+                // Avoid adding extraneous leading empty lines if content is just starting
+                if (currentNode.markdownContent === '' && line.trim() === '') {
+                    continue;
+                }
+                currentNode.markdownContent += line + '\n';
+            }
+        }
+    }
+    // Clean up trailing whitespace on markdown content
+    const cleanMarkdown = (nodes) => {
+        for (const node of nodes) {
+            node.markdownContent = node.markdownContent.trim();
+            cleanMarkdown(node.children);
+        }
+    };
+    cleanMarkdown(rootNodes);
+    return rootNodes;
+}

package/build/types.js

@@ -0,0 +1,3 @@
+"use strict";
+// Central location for AST Node interfaces
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@tdocs/tdocs",
+  "version": "1.0.0",
+  "description": "Custom Static Site Generator for rapid documentation prototyping",
+  "main": "./build/index.js",
+  "bin": {
+    "tdoc": "./build/index.js"
+  },
+  "files": [
+    "build/**/*",
+    "templates/**/*"
+  ],
+  "scripts": {
+    "build:cli": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "browser-sync": "^3.0.4",
+    "chokidar": "^5.0.0",
+    "commander": "^14.0.3",
+    "ejs": "^5.0.1",
+    "highlight.js": "^11.11.1",
+    "marked": "^17.0.4",
+    "marked-highlight": "^2.2.3"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/browser-sync": "^2.29.1",
+    "@types/ejs": "^3.1.5",
+    "@types/marked": "^5.0.2",
+    "@types/node": "^25.5.0",
+    "gray-matter": "^4.0.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}

package/templates/layout.ejs

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= config.title || 'Documentation' %></title>
+  <link rel="stylesheet" href="style.css">
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css">
+  <style>
+    .nav-item { margin-left: var(--indent, 0px); padding: 5px 0; cursor: pointer; color: var(--accent-color); }
+    .nav-item:hover { text-decoration: underline; }
+    .nav-item.active { font-weight: bold; color: var(--text-color); }
+  </style>
+</head>
+<body>
+  <header>
+    <h1><%= config.header || 'TDoc Site' %></h1>
+  </header>
+
+  <div class="layout">
+    <aside class="sidebar" id="sidebar">
+      <!-- Sidebar navigation populated by JS -->
+    </aside>
+
+    <main class="content" id="content-area">
+      <!-- Main documentation content will go here -->
+    </main>
+  </div>
+
+  <footer>
+    <p><%= config.footer || 'Generated with TDoc' %></p>
+  </footer>
+
+  <script>
+    const tree = <%- serializeTree(tree) %>;
+    
+    const sidebar = document.getElementById('sidebar');
+    const contentArea = document.getElementById('content-area');
+    
+    // Flatten tree to a map for easy lookup
+    const nodeMap = {};
+    
+    function renderSidebar(nodes, parentEl) {
+      nodes.forEach(node => {
+        nodeMap[node.id] = node;
+        
+        const div = document.createElement('div');
+        div.className = 'nav-item';
+        div.style.setProperty('--indent', `${node.level * 15}px`);
+        div.textContent = node.title;
+        div.onclick = () => {
+          document.querySelectorAll('.nav-item').forEach(el => el.classList.remove('active'));
+          div.classList.add('active');
+          contentArea.innerHTML = node.htmlContent;
+        };
+        
+        parentEl.appendChild(div);
+        
+        if (node.children && node.children.length > 0) {
+          renderSidebar(node.children, parentEl);
+        }
+      });
+    }
+
+    renderSidebar(tree, sidebar);
+
+    // Render the first item by default if exists
+    if (tree.length > 0) {
+        sidebar.firstChild.click();
+    }
+  </script>
+</body>
+</html>

package/templates/style.css

@@ -0,0 +1,51 @@
+:root {
+  --bg-color: #ffffff;
+  --text-color: #333333;
+  --sidebar-bg: #f5f5f5;
+  --header-bg: #1a1a1a;
+  --header-text: #ffffff;
+  --accent-color: #0066cc;
+}
+
+body {
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+  margin: 0;
+  padding: 0;
+  background-color: var(--bg-color);
+  color: var(--text-color);
+  display: flex;
+  flex-direction: column;
+  min-height: 100vh;
+}
+
+header {
+  background-color: var(--header-bg);
+  color: var(--header-text);
+  padding: 1rem 2rem;
+}
+
+.layout {
+  display: flex;
+  flex: 1;
+}
+
+.sidebar {
+  width: 250px;
+  background-color: var(--sidebar-bg);
+  padding: 2rem 1rem;
+  border-right: 1px solid #e0e0e0;
+}
+
+.content {
+  flex: 1;
+  padding: 2rem 4rem;
+  max-width: 900px;
+}
+
+footer {
+  padding: 1rem 2rem;
+  text-align: center;
+  border-top: 1px solid #e0e0e0;
+  font-size: 0.9rem;
+  color: #666;
+}