@mgks/docmd 0.3.6 → 0.3.8

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 mgks
+Copyright (c) 2025 docmd (docmd.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,92 +1,96 @@
 <div align="center">
-  <a href="https://docmd.mgks.dev">
-    <img src="https://github.com/mgks/docmd/blob/main/src/assets/images/docmd-logo-light.png?raw=true" alt="docmd logo" width="150" />
-  </a>
+
+  <!-- PROJECT TITLE -->
+  <h1>
+    <img src="https://github.com/docmd-io/docmd/blob/main/src/assets/images/docmd-logo-dark.png?raw=true" alt="docmd logo" width="200" />
+    <!-- docmd -->
+  </h1>
+  
+  <!-- ONE LINE SUMMARY -->
   <p>
-    <strong>The minimalist, zero-config documentation generator.</strong>
+    <b>The minimalist, zero-config documentation generator.</b>
+  </p>
+  
+  <!-- BADGES -->
+  <p>
+    <a href="https://www.npmjs.com/package/@mgks/docmd"><img src="https://img.shields.io/npm/v/@mgks/docmd.svg?style=flat-square&color=d25353" alt="npm version"></a>
+    <a href="https://github.com/docmd-io/docmd/commits/main/"><img src="https://img.shields.io/github/commit-activity/m/docmd-io/docmd?style=flat-square&color=38bd24" alt="commits"></a>
+    <a href="https://www.npmjs.com/package/@mgks/docmd?activeTab=versions"><img src="https://img.shields.io/npm/dt/@mgks/docmd.svg?style=flat-square&color=38bd24" alt="downloads"></a>
+    <a href="https://github.com/docmd-io/docmd/stargazers"><img src="https://img.shields.io/github/stars/docmd-io/docmd?style=flat-square&logo=github" alt="stars"></a>
+    <a href="https://github.com/docmd-io/docmd/blob/main/LICENSE"><img src="https://img.shields.io/github/license/docmd-io/docmd.svg?style=flat-square&color=blue" alt="license"></a>
   </p>
-</div>
 
-<p align="center">
-  <a href="https://www.npmjs.com/package/@mgks/docmd"><img src="https://img.shields.io/npm/v/@mgks/docmd.svg?style=flat-square&color=fc3b53" alt="npm version"></a>
-<a href="https://github.com/mgks/docmd/commits"><img src="https://img.shields.io/github/commit-activity/m/mgks/docmd?style=flat-square&color=38bd24" alt="commits"></a>
-  <a href="https://www.npmjs.com/package/@mgks/docmd"><img src="https://img.shields.io/npm/dt/@mgks/docmd.svg?style=flat-square&color=38bd24" alt="downloads"></a>
-  <a href="https://github.com/mgks/docmd/stargazers"><img src="https://img.shields.io/github/stars/mgks/docmd?style=flat-square&logo=github" alt="stars"></a>
-  <a href="LICENSE"><img src="https://img.shields.io/github/license/mgks/docmd.svg?style=flat-square&color=blue" alt="license"></a>
-</p>
-
-<p align="center">
-  <a href="https://docmd.mgks.dev"><b>View Live Demo</b></a> • 
-  <a href="https://docmd.mgks.dev/getting-started/installation/"><b>Read Documentation</b></a> • 
-  <a href="https://docmd.mgks.dev/live/"><b>Live Editor</b></a> •
-  <a href="https://github.com/mgks/docmd/issues"><b>Report Bug</b></a>
-</p>
-
-<p align="center">
-  <img width="800" alt="docmd preview" src="https://docmd.mgks.dev/assets/images/preview-dark-welcome.png" style="border-radius: 10px" />
-  <br/>
-  <sup><i>docmd noStyle page preview in dark mode</i></sup>
-</p>
+  <!-- MENU -->
+  <p>
+    <h4>
+      <a href="https://docmd.io">View Demo</a> • 
+      <a href="https://docs.docmd.io/getting-started/installation/">Documentation</a> • 
+      <a href="https://live.docmd.io">Live Editor</a> •
+      <a href="https://github.com/docmd-io/docmd/issues">Report Bug</a>
+    </h4>
+  </p>
+
+  <!-- PREVIEW -->
+  <p>
+    <img width="800" alt="docmd preview" src="https://github.com/user-attachments/assets/1a74d6f7-10f9-41fa-be8a-faeee278dbb9" />
+    <br/>
+    <sup><i>docmd noStyle page preview in light mode</i></sup>
+  </p>
+
+</div>
 
 ## Features
 
 - **Zero Config**: Works out of the box with sensible defaults. Just `init` and go.
 - **Blazing Fast**: Generates **pure, static HTML**. No React hydration lag, no heavy bundles.
 - **Smart Search**: Built-in, **offline-capable** full-text search with fuzzy matching. No API keys required.
-- **Isomorphic Core**: Runs anywhere—Node.js CLI, CI/CD pipelines, or **directly in the browser** via WASM.
+- **Isomorphic Core**: Runs anywhere, Node.js CLI, CI/CD pipelines, or **directly in the browser**.
 - **Rich Content**: Built-in support for Callouts, Cards, Tabs, Steps, Changelogs, and Mermaid diagrams.
 - **Theming**: Beautiful light/dark modes and multiple pre-built themes (`sky`, `ruby`, `retro`).
 
-## Quick Start
-
-**Installation:**
+## Installation
 
 ```bash
 npm install -g @mgks/docmd
 ```
 
-**Run:**
+## Usage
+
+### CLI
+
+The Command Line Interface is the primary way to interact with `docmd`.
 
 ```bash
-docmd init my-docs     # Initialize a new project
-cd my-docs             # Enter directory
-docmd dev              # Start live-reloading server
-docmd build            # Generate static site for deployment
-docmd live             # Launch live editor to preview and design pages
+docmd init      # Initialize a new project with config and assets
+docmd dev       # Start a local development server with hot-reload
+docmd build     # Generate a production-ready static site in ./site
+docmd live      # Launch the browser-based Live Editor locally
 ```
 
-**Dev Server:**
-
-```js
-                       
-     _                 _ 
-   _| |___ ___ _____ _| |
-  | . | . |  _|     | . |
-  |___|___|___|_|_|_|___|
-  
-   v0.x.x
+### API
 
+`docmd` exports its core engine, allowing you to build documentation programmatically within your own Node.js scripts or build tools.
 
-🚀 Performing initial build...
+```javascript
+const { build, buildLive } = require('@mgks/docmd');
 
-👀 Watching for changes in:
-   - Source: ./docs
-   - Config: ./config.js
-   - Assets: ./assets
+// Trigger a standard documentation build
+await build('./docmd.config.js', { 
+  isDev: false, 
+  preserve: true 
+});
 
-────────────────────────────────────────
-  SERVER RUNNING  (v0.3.5)
+// Trigger a Live Editor bundle build
+await buildLive(); 
+```
 
-  Local:    http://127.0.0.1:3000
-  Network:  http://192.1.1.1:3000
+### Live Editor
 
-  Serving:  ./site
-────────────────────────────────────────
-```
+`docmd` features a modular architecture that allows the core engine to run client-side. 
 
-## Usage in Detail
+Running `docmd live` builds a standalone web application where you can write Markdown and see the preview instantly without any server-side processing. You can embed the generated `docmd-live.js` bundle to add Markdown capabilities to your own applications.
 
-### Project Structure
+## Project Structure
 
 `docmd` keeps it simple. Your content lives in `docs/`, your config in `docmd.config.js`.
 
@@ -96,43 +100,48 @@ my-docs/
 │   ├── index.md           # Homepage
 │   └── guide.md           # Content page
 ├── assets/                # Images and custom CSS
-└── docmd.config.js        # Configuration
+├── docmd.config.js        # Configuration
+└── package.json
 ```
 
-### Configuration
+## Configuration
 
 Customize your site in seconds via `docmd.config.js`:
 
 ```javascript
 module.exports = {
   siteTitle: 'My Project',
+  siteUrl: 'https://mysite.com',
   srcDir: 'docs',
   outputDir: 'site',
+  
+  // Theme Settings
   theme: {
     name: 'sky',           // 'default', 'sky', 'ruby', 'retro'
-    defaultMode: 'dark',   // 'light' or 'dark'
+    defaultMode: 'system', // 'light', 'dark', or 'system'
     enableModeToggle: true
   },
+  
+  // Sidebar Navigation
   navigation: [
     { title: 'Home', path: '/', icon: 'home' },
-    { title: 'Guide', path: '/guide', icon: 'book' }
-  ]
+    { 
+      title: 'Guide', 
+      icon: 'book',
+      children: [
+        { title: 'Installation', path: '/guide/install' }
+      ]
+    }
+  ],
+
+  // Plugins
+  plugins: {
+    seo: { /* ... */ },
+    sitemap: { /* ... */ }
+  }
 }
 ```
 
-## Live Editor
-
-`docmd` comes with a modular architecture that allows the core engine to run client-side.
-
-**Launch locally:**
-```bash
-docmd live
-```
-This builds and serves a local editor where you can write Markdown and see the preview instantly without any server-side processing.
-
-**Embed in your app:**
-You can also use the `dist/docmd-live.js` bundle to add Markdown compilation capabilities to your own web applications.
-
 ## Comparison
 
 | Feature | docmd | Docusaurus | MkDocs | Mintlify |

package/bin/docmd.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 
 const { program } = require('commander');
-// This import corresponds to module.exports = { startDevServer } in src/commands/dev.js
 const { startDevServer } = require('../src/commands/dev'); 
 const { buildSite } = require('../src/commands/build');
 const { initProject } = require('../src/commands/init');
+const { build: buildLive } = require('../src/commands/live');
 const { version } = require('../package.json');
 const { printBanner } = require('../src/core/logger');
 const path = require('path');
@@ -51,25 +51,22 @@ program
 program
   .command('live')
   .description('Build and serve the browser-based live editor')
-  .action(() => {
-    const scriptPath = path.resolve(__dirname, '../scripts/build-live.js');
-    const distPath = path.resolve(__dirname, '../dist');
-    
-    console.log('🚀 Starting Live Editor build...');
-    
-    // Using spawn ensures the build runs in a fresh process context
-    const build = spawn(process.execPath, [scriptPath], { stdio: 'inherit' });
-    
-    build.on('close', (code) => {
-      if (code === 0) {
+  .action(async () => {
+    try {
+        await buildLive();
+
         console.log('\n🌍 Launching server...');
         console.log('   Press Ctrl+C to stop.\n');
-        
-        // Fix for Node DeprecationWarning regarding shell: true
+
+        const distPath = path.resolve(__dirname, '../dist');
         const serveCmd = `npx serve "${distPath}"`;
+
         spawn(serveCmd, { stdio: 'inherit', shell: true });
-      }
-    });
+        
+    } catch (e) {
+        console.error('Live build failed:', e);
+        process.exit(1);
+    }
   });
 
 program.parse();

package/bin/postinstall.js

@@ -1,14 +1,14 @@
-// bin/postinstall.js
-
-const chalk = require('chalk');
+// Source file from the docmd project — https://github.com/docmd-io/docmd
 
 // This script runs after 'npm install', runs only when the user installs it globally and not in a CI environment
 
+const chalk = require('chalk');
+
 if (process.env.npm_config_global && !process.env.CI) {
   console.log(chalk.green('\n🎉 Thank you for installing docmd!'));
   console.log('\nTo get started, run the following commands:');
   console.log(`\n  ${chalk.cyan('docmd init my-awesome-docs')}`);
   console.log(`  ${chalk.cyan('cd my-awesome-docs')}`);
   console.log(`  ${chalk.cyan('npm start')}`);
-  console.log('\nFor complete documentation, visit: https://docmd.mgks.dev');
+  console.log('\nFor complete documentation, visit: https://docmd.io');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgks/docmd",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "description": "Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.",
   "main": "src/index.js",
   "exports": {
@@ -9,27 +9,32 @@
       "require": "./src/index.js"
     }
   },
+  "files": [
+    "bin",
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
   "bin": {
     "docmd": "bin/docmd.js"
   },
   "scripts": {
-    "start": "node ./bin/docmd.js dev",
-    "build": "node ./bin/docmd.js build",
-    "live": "node scripts/build-live.js && npx serve dist",
-    "postinstall": "node ./bin/postinstall.js",
+    "test": "node scripts/failsafe.js",
+    "prepublishOnly": "npm test",
+    "start": "node bin/docmd.js dev",
+    "build": "node bin/docmd.js build",
+    "live": "node bin/docmd.js live",
+    "postinstall": "node bin/postinstall.js",
     "lint": "eslint .",
-    "format": "prettier --write .",
-    "test": "echo \"No tests specified currently\" && exit 0"
+    "format": "prettier --write ."
   },
   "dependencies": {
+    "buffer": "^6.0.3",
     "chalk": "^4.1.2",
     "chokidar": "^5.0.0",
-    "clean-css": "^5.3.3",
     "commander": "^14.0.2",
     "ejs": "^3.1.10",
     "esbuild": "^0.27.2",
-    "express": "^5.2.1",
-    "fs-extra": "^11.3.3",
     "gray-matter": "^4.0.3",
     "highlight.js": "^11.11.1",
     "lucide-static": "^0.562.0",
@@ -40,10 +45,8 @@
     "markdown-it-deflist": "^3.0.0",
     "markdown-it-footnote": "^4.0.0",
     "markdown-it-task-lists": "^2.1.1",
-    "mermaid": "^11.12.2",
     "minisearch": "^7.2.0",
-    "striptags": "^3.2.0",
-    "ws": "^8.18.3"
+    "ws": "^8.19.0"
   },
   "devDependencies": {
     "buffer": "^6.0.3",
@@ -70,12 +73,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mgks/docmd.git"
+    "url": "git+https://github.com/docmd-io/docmd.git"
   },
   "bugs": {
-    "url": "https://github.com/mgks/docmd/issues"
+    "url": "https://github.com/docmd-io/docmd/issues"
   },
-  "homepage": "https://github.com/mgks/docmd#readme",
+  "homepage": "https://docmd.io",
   "funding": "https://github.com/sponsors/mgks",
   "license": "MIT"
 }

package/src/assets/css/docmd-highlight-dark.css

@@ -1 +1,86 @@
-pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#abb2bf;background:#282c34}.hljs-comment,.hljs-quote{color:#5c6370;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#c678dd}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e06c75}.hljs-literal{color:#56b6c2}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#98c379}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#d19a66}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#61aeee}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#e6c07b}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}
+/* Source file from the docmd project — https://github.com/docmd-io/docmd */
+
+pre code.hljs {
+    display: block;
+    overflow-x: auto;
+    padding: 1em
+}
+
+code.hljs {
+    padding: 3px 5px
+}
+
+.hljs {
+    color: #abb2bf;
+    background: #282c34
+}
+
+.hljs-comment,
+.hljs-quote {
+    color: #5c6370;
+    font-style: italic
+}
+
+.hljs-doctag,
+.hljs-formula,
+.hljs-keyword {
+    color: #c678dd
+}
+
+.hljs-deletion,
+.hljs-name,
+.hljs-section,
+.hljs-selector-tag,
+.hljs-subst {
+    color: #e06c75
+}
+
+.hljs-literal {
+    color: #56b6c2
+}
+
+.hljs-addition,
+.hljs-attribute,
+.hljs-meta .hljs-string,
+.hljs-regexp,
+.hljs-string {
+    color: #98c379
+}
+
+.hljs-attr,
+.hljs-number,
+.hljs-selector-attr,
+.hljs-selector-class,
+.hljs-selector-pseudo,
+.hljs-template-variable,
+.hljs-type,
+.hljs-variable {
+    color: #d19a66
+}
+
+.hljs-bullet,
+.hljs-link,
+.hljs-meta,
+.hljs-selector-id,
+.hljs-symbol,
+.hljs-title {
+    color: #61aeee
+}
+
+.hljs-built_in,
+.hljs-class .hljs-title,
+.hljs-title.class_ {
+    color: #e6c07b
+}
+
+.hljs-emphasis {
+    font-style: italic
+}
+
+.hljs-strong {
+    font-weight: 700
+}
+
+.hljs-link {
+    text-decoration: underline
+}

package/src/assets/css/docmd-highlight-light.css

@@ -1 +1,86 @@
-pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#383a42;background:#fafafa}.hljs-comment,.hljs-quote{color:#a0a1a7;font-style:italic}.hljs-doctag,.hljs-formula,.hljs-keyword{color:#a626a4}.hljs-deletion,.hljs-name,.hljs-section,.hljs-selector-tag,.hljs-subst{color:#e45649}.hljs-literal{color:#0184bb}.hljs-addition,.hljs-attribute,.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#50a14f}.hljs-attr,.hljs-number,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-pseudo,.hljs-template-variable,.hljs-type,.hljs-variable{color:#986801}.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-symbol,.hljs-title{color:#4078f2}.hljs-built_in,.hljs-class .hljs-title,.hljs-title.class_{color:#c18401}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700}.hljs-link{text-decoration:underline}
+/* Source file from the docmd project — https://github.com/docmd-io/docmd */
+
+pre code.hljs {
+    display: block;
+    overflow-x: auto;
+    padding: 1em
+}
+
+code.hljs {
+    padding: 3px 5px
+}
+
+.hljs {
+    color: #383a42;
+    background: #fafafa
+}
+
+.hljs-comment,
+.hljs-quote {
+    color: #a0a1a7;
+    font-style: italic
+}
+
+.hljs-doctag,
+.hljs-formula,
+.hljs-keyword {
+    color: #a626a4
+}
+
+.hljs-deletion,
+.hljs-name,
+.hljs-section,
+.hljs-selector-tag,
+.hljs-subst {
+    color: #e45649
+}
+
+.hljs-literal {
+    color: #0184bb
+}
+
+.hljs-addition,
+.hljs-attribute,
+.hljs-meta .hljs-string,
+.hljs-regexp,
+.hljs-string {
+    color: #50a14f
+}
+
+.hljs-attr,
+.hljs-number,
+.hljs-selector-attr,
+.hljs-selector-class,
+.hljs-selector-pseudo,
+.hljs-template-variable,
+.hljs-type,
+.hljs-variable {
+    color: #986801
+}
+
+.hljs-bullet,
+.hljs-link,
+.hljs-meta,
+.hljs-selector-id,
+.hljs-symbol,
+.hljs-title {
+    color: #4078f2
+}
+
+.hljs-built_in,
+.hljs-class .hljs-title,
+.hljs-title.class_ {
+    color: #c18401
+}
+
+.hljs-emphasis {
+    font-style: italic
+}
+
+.hljs-strong {
+    font-weight: 700
+}
+
+.hljs-link {
+    text-decoration: underline
+}