@mgks/docmd 0.3.9 → 0.4.0

package/README.md

@@ -1,167 +1,22 @@
-<div align="center">
+## ⚠️ @mgks/docmd [DEPRECATED]
 
-  <!-- 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>
-    <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>
+⚠️ **THIS PACKAGE HAS BEEN RENAMED.** ⚠️
 
-  <!-- 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>
+We have moved! Please use **[@docmd/core](https://www.npmjs.com/package/@docmd/core)** for all future updates.
 
-  <!-- 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>
+## 🚨 Migration Guide
 
-</div>
+1. **Uninstall** the old package:
+   ```bash
+   npm uninstall -g @mgks/docmd
+   ```
 
-## Features
+2. **Install** the new core:
+   ```bash
+   npm install -g @docmd/core
+   ```
 
-- **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**.
-- **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`).
+## What is this?
+This package is a legacy wrapper. It currently forwards all commands to the new `@docmd/core` engine to prevent breaking existing CI/CD pipelines, but **it will not receive new features**.
 
-## Installation
-
-```bash
-npm install -g @mgks/docmd
-```
-
-## Usage
-
-### CLI
-
-The Command Line Interface is the primary way to interact with `docmd`.
-
-```bash
-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
-```
-
-### API
-
-`docmd` exports its core engine, allowing you to build documentation programmatically within your own Node.js scripts or build tools.
-
-```javascript
-const { build, buildLive } = require('@mgks/docmd');
-
-// Trigger a standard documentation build
-await build('./docmd.config.js', { 
-  isDev: false, 
-  preserve: true 
-});
-
-// Trigger a Live Editor bundle build
-await buildLive(); 
-```
-
-### Live Editor
-
-`docmd` features a modular architecture that allows the core engine to run client-side. 
-
-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
-
-`docmd` keeps it simple. Your content lives in `docs/`, your config in `docmd.config.js`.
-
-```bash
-my-docs/
-├── docs/                  # Your Markdown files
-│   ├── index.md           # Homepage
-│   └── guide.md           # Content page
-├── assets/                # Images and custom CSS
-├── docmd.config.js        # Configuration
-└── package.json
-```
-
-## 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: 'system', // 'light', 'dark', or 'system'
-    enableModeToggle: true
-  },
-  
-  // Sidebar Navigation
-  navigation: [
-    { title: 'Home', path: '/', icon: 'home' },
-    { 
-      title: 'Guide', 
-      icon: 'book',
-      children: [
-        { title: 'Installation', path: '/guide/install' }
-      ]
-    }
-  ],
-
-  // Plugins
-  plugins: {
-    seo: { /* ... */ },
-    sitemap: { /* ... */ }
-  }
-}
-```
-
-## Comparison
-
-| Feature | docmd | Docusaurus | MkDocs | Mintlify |
-| :--- | :--- | :--- | :--- | :--- |
-| **Language** | **Node.js** | React.js | Python | Proprietary |
-| **Output** | **Static HTML** | React SPA | Static HTML | Hosted |
-| **JS Payload** | **Tiny (< 15kb)** | Heavy | Minimal | Medium |
-| **Search** | **Built-in (Offline)** | Algolia (Ext) | Built-in | Built-in |
-| **Setup** | **~1 min** | ~15 mins | ~10 mins | Instant |
-| **Cost** | **Free OSS** | Free OSS | Free OSS | Freemium |
-
-## Community & Support
-
-- **Contributing**: We welcome PRs! See [CONTRIBUTING.md](.github/CONTRIBUTING.md).
-- **Support**: If you find `docmd` useful, please consider [sponsoring the project](https://github.com/sponsors/mgks) or giving it a star ⭐.
-
-## License
-
-Distributed under the MIT License. See `LICENSE` for more information.
-
-> **{ github.com/mgks }**
-> 
-> ![Website Badge](https://img.shields.io/badge/Visit-mgks.dev-blue?style=flat&link=https%3A%2F%2Fmgks.dev) ![Sponsor Badge](https://img.shields.io/badge/%20%20Become%20a%20Sponsor%20%20-red?style=flat&logo=github&link=https%3A%2F%2Fgithub.com%2Fsponsors%2Fmgks)
+Please update your scripts to use `@docmd/core`.

package/bin/docmd.js

@@ -1,72 +1,9 @@
 #!/usr/bin/env node
 
-const { program } = require('commander');
-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');
-const { spawn } = require('child_process');
+console.error('\x1b[33m%s\x1b[0m', '⚠️  DEPRECATION NOTICE:');
+console.error('\x1b[33m%s\x1b[0m', '   You are using the legacy package "@mgks/docmd".');
+console.error('\x1b[33m%s\x1b[0m', '   Please uninstall it and install "@docmd/core" for future updates.');
+console.error('\x1b[33m%s\x1b[0m', '   Redirecting to new engine...\n');
 
-program
-  .name('docmd')
-  .description('The minimalist, zero-config documentation generator')
-  .version(version, '-v, --version', 'Output the current version')
-  .helpOption('-h, --help', 'Display help for command');
-
-program
-  .command('init')
-  .description('Initialize a new documentation project')
-  .action(() => {
-    printBanner();
-    initProject();
-  });
-
-program
-  .command('dev')
-  .description('Start the development server with live reload')
-  .option('-c, --config <path>', 'Path to configuration file', 'docmd.config.js')
-  .option('-p, --port <number>', 'Port to run the server on')
-  .option('--preserve', 'Preserve existing assets', false)
-  .action((options) => {
-    printBanner();
-    startDevServer(options.config, options);
-  });
-
-program
-  .command('build')
-  .description('Build the static documentation site')
-  .option('-c, --config <path>', 'Path to configuration file', 'docmd.config.js')
-  .option('--preserve', 'Preserve existing assets', false)
-  .action((options) => {
-    buildSite(options.config, { isDev: false, preserve: options.preserve });
-  })
-  .option('--offline', 'Generate a build optimized for file:// viewing (appends index.html)', false)
-  .action((options) => {
-    buildSite(options.config, { isDev: false, preserve: options.preserve, offline: options.offline });
-  });
-
-program
-  .command('live')
-  .description('Build and serve the browser-based live editor')
-  .action(async () => {
-    try {
-        await buildLive();
-
-        console.log('\n🌍 Launching server...');
-        console.log('   Press Ctrl+C to stop.\n');
-
-        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();
+// Pass control to the core binary
+require('@docmd/core/bin/docmd.js');

package/package.json

@@ -1,84 +1,11 @@
 {
   "name": "@mgks/docmd",
-  "version": "0.3.9",
-  "description": "Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.",
-  "main": "src/index.js",
-  "exports": {
-    ".": {
-      "import": "./src/index.js",
-      "require": "./src/index.js"
-    }
-  },
-  "files": [
-    "bin",
-    "src",
-    "LICENSE",
-    "README.md"
-  ],
+  "version": "0.4.0",
+  "description": "Legacy wrapper for docmd. Please use @docmd/core.",
   "bin": {
-    "docmd": "bin/docmd.js"
-  },
-  "scripts": {
-    "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 ."
+    "docmd": "./bin/docmd.js"
   },
   "dependencies": {
-    "buffer": "^6.0.3",
-    "chalk": "^4.1.2",
-    "chokidar": "^5.0.0",
-    "commander": "^14.0.2",
-    "ejs": "^3.1.10",
-    "esbuild": "^0.27.2",
-    "gray-matter": "^4.0.3",
-    "highlight.js": "^11.11.1",
-    "lucide-static": "^0.563.0",
-    "markdown-it": "^14.1.0",
-    "markdown-it-abbr": "^2.0.0",
-    "markdown-it-attrs": "^4.3.1",
-    "markdown-it-container": "^4.0.0",
-    "markdown-it-deflist": "^3.0.0",
-    "markdown-it-footnote": "^4.0.0",
-    "markdown-it-task-lists": "^2.1.1",
-    "minisearch": "^7.2.0",
-    "ws": "^8.19.0"
-  },
-  "devDependencies": {
-    "buffer": "^6.0.3",
-    "eslint": "^9.39.2",
-    "prettier": "^3.7.4"
-  },
-  "directories": {
-    "doc": "docs"
-  },
-  "keywords": [
-    "markdown",
-    "static-site-generator",
-    "documentation",
-    "ssg",
-    "docs",
-    "generator"
-  ],
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "author": {
-    "name": "Ghazi",
-    "url": "https://mgks.dev"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/docmd-io/docmd.git"
-  },
-  "bugs": {
-    "url": "https://github.com/docmd-io/docmd/issues"
-  },
-  "homepage": "https://docmd.io",
-  "funding": "https://github.com/sponsors/mgks",
-  "license": "MIT"
-}
+    "@docmd/core": "0.4.0"
+  }
+}

package/bin/postinstall.js

@@ -1,14 +0,0 @@
-// 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.io');
-}

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

@@ -1,86 +0,0 @@
-/* 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,86 +0,0 @@
-/* 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
-}