Summary

docmd is a minimalist, zero-configuration static site generator designed for developers to create fast, beautiful documentation from Markdown. It prioritizes content and performance by avoiding heavy JavaScript frameworks, offering a tiny JS payload and rapid build times. A key differentiator is its AI-readiness, automatically generating llms.txt files to aid AI agents, making documentation more accessible to machine learning models.

How It Works

docmd employs a Node.js-based engine that can run both as a CLI tool and client-side in the browser, enabling an isomorphic architecture. It compiles Markdown content into pure static HTML, CSS, and minimal JavaScript, ensuring fast load times and a small footprint. The generator supports rich content elements like tabs, callouts, and Mermaid diagrams natively, and features built-in, privacy-friendly full-text search without external dependencies.

Quick Start & Requirements

• Installation: npm install -g @docmd/core
• Prerequisites: Node.js.
• Usage: docmd init (initialize project), docmd dev (start dev server with hot-reload), docmd build (generate static site).
• API: Programmatic use via require('@docmd/core') for Node.js scripts.
• Links: View Demo, Documentation, Live Editor

Highlighted Details

• Zero Config: Works out-of-the-box with sensible defaults.
• Fast Output: Generates pure static HTML with a JS payload under 15kb.
• AI-Ready: Automatically generates llms.txt for AI agents.
• Smart Search: Built-in, privacy-friendly full-text search.
• Rich Content: Native support for Tabs, Steps, Callouts, and Mermaid diagrams.
• Theming: Beautiful light/dark modes and multiple pre-built themes ('default', 'sky', 'ruby', 'retro').
• Setup Time: Estimated at ~1 minute.

Maintenance & Community

The project welcomes contributions via Pull Requests. Support is encouraged through project sponsorship or GitHub stars. No specific community channels (like Discord/Slack) or roadmap links are provided in the README.

Licensing & Compatibility

Distributed under the MIT License. This license is permissive and generally compatible with commercial use and closed-source projects.

Limitations & Caveats

The provided README does not explicitly detail limitations, unsupported platforms, or known bugs. The project appears to be actively maintained, with a focus on core documentation generation features.