{"id":43582621,"url":"https://github.com/docmd-io/docmd","last_synced_at":"2026-03-09T23:37:17.625Z","repository":{"id":292095112,"uuid":"979799945","full_name":"docmd-io/docmd","owner":"docmd-io","description":"Generate minimal, fast \u0026 beautiful docs from Markdown. No React, no bloat, just content. Built for developers.","archived":false,"fork":false,"pushed_at":"2026-01-16T03:55:48.000Z","size":7779,"stargazers_count":614,"open_issues_count":5,"forks_count":40,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-27T13:07:30.279Z","etag":null,"topics":["containers","documentation","documentation-generator","markdown","nodejs","npm","plugins"],"latest_commit_sha":null,"homepage":"https://docmd.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docmd-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"mgks","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2025-05-08T04:58:58.000Z","updated_at":"2026-01-25T23:16:57.000Z","dependencies_parsed_at":"2025-05-28T11:32:59.977Z","dependency_job_id":"febcbec6-e824-4a50-84ef-af56c6473deb","html_url":"https://github.com/docmd-io/docmd","commit_stats":null,"previous_names":["mgks/docmd","docmd-io/docmd"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/docmd-io/docmd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmd-io%2Fdocmd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmd-io%2Fdocmd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmd-io%2Fdocmd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmd-io%2Fdocmd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docmd-io","download_url":"https://codeload.github.com/docmd-io/docmd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docmd-io%2Fdocmd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29062484,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-03T23:14:54.203Z","status":"ssl_error","status_checked_at":"2026-02-03T23:14:50.873Z","response_time":96,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["containers","documentation","documentation-generator","markdown","nodejs","npm","plugins"],"created_at":"2026-02-04T00:03:15.748Z","updated_at":"2026-03-09T23:37:17.602Z","avatar_url":"https://github.com/docmd-io.png","language":"JavaScript","readme":"\u003cdiv align=\"center\"\u003e\n\n  \u003c!-- PROJECT TITLE --\u003e\n  \u003ch3\u003e\n    \u003cimg src=\"https://github.com/docmd-io/docmd/blob/main/packages/ui/assets/images/docmd-logo-dark.png?raw=true\" alt=\"docmd logo\" width=\"210\" /\u003e\n  \u003c/h3\u003e\n  \n  \u003c!-- ONE LINE SUMMARY --\u003e\n  \u003cp\u003e\n    \u003cb\u003eThe minimalist, zero-config documentation generator.\u003c/b\u003e\n  \u003c/p\u003e\n  \n  \u003c!-- BADGES --\u003e\n  \u003cp\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@docmd/core\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@docmd/core.svg?style=flat-square\u0026color=CB3837\" alt=\"npm version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@docmd/core?activeTab=versions\"\u003e\u003cimg src=\"https://img.shields.io/npm/d18m/%40mgks%2Fdocmd?style=flat\u0026label=%40mgks%2Fdocmd%20(legacy)\" alt=\"downloads\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@docmd/core?activeTab=versions\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/@docmd/core.svg?style=flat-square\u0026color=38bd24\" alt=\"downloads\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/docmd-io/docmd/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/docmd-io/docmd?style=flat-square\u0026logo=github\" alt=\"stars\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/docmd-io/docmd/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/docmd-io/docmd.svg?style=flat-square\u0026color=A31F34\" alt=\"license\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\n  \u003c!-- MENU --\u003e\n  \u003cp\u003e\n    \u003ch4\u003e\n      \u003ca href=\"https://docmd.io\"\u003eView Demo\u003c/a\u003e • \n      \u003ca href=\"https://docs.docmd.io/getting-started/installation/\"\u003eDocumentation\u003c/a\u003e • \n      \u003ca href=\"https://live.docmd.io\"\u003eLive Editor\u003c/a\u003e •\n      \u003ca href=\"https://github.com/docmd-io/docmd/issues\"\u003eReport Bug\u003c/a\u003e\n    \u003c/h4\u003e\n  \u003c/p\u003e\n\n  \u003c!-- PREVIEW --\u003e\n  \u003cp\u003e\n    \u003cbr/\u003e\n    \u003cimg width=\"800\" alt=\"docmd preview\" src=\"https://github.com/user-attachments/assets/92558d3a-7c0d-46bc-862e-466c42cb7be4\" /\u003e\n    \u003cbr/\u003e\n    \u003csup\u003e\u003ci\u003edocmd `default` theme in light appearance\u003c/i\u003e\u003c/sup\u003e\n  \u003c/p\u003e\n\n\u003c/div\u003e\n\n## Features\n\n- **Zero Config**: Intelligent auto-routing scans your folders and builds navigation trees instantly.\n- **Versioning**: Enterprise-grade versioning (v1, v2) with sticky context switching and smart routing.\n- **Super Fast**: Generates pure static HTML. No hydration gap. No heavy React/Vue overhead.\n- **AI-Ready**: Automatically generates `llms.txt` and `llms-full.txt` context for AI agents.\n- **PWA**: Native Progressive Web App support for offline access and smart background caching.\n- **Smart Search**: Built-in, privacy-friendly offline search with deep-linking to exact headers.\n- **Isomorphic**: Runs seamlessly in Node.js (CLI) or directly in the browser via Live Editor.\n- **Rich Content**: Native Markdown support for Tabs, Steps, Callouts, and Mermaid diagrams.\n- **SEO Optimized**: Auto-generates sitemaps, canonical tags, 404 pages, and static HTML redirects.\n\n## Getting Started\n\nYou can run `docmd` on-the-fly without installing, or add it permanently to your long term projects.\n\n### Option 1: Zero-Config (Try it instantly)\nRun `docmd` inside any folder containing markdown files. It will automatically extract your headers and build a nested navigation sidebar.\n```bash\n# Start local dev server\nnpx @docmd/core dev -z\n\n# Generate production static site\nnpx @docmd/core build -z\n```\n\u003e **Note:** Zero-Config (`-z`) is currently in `beta`. It is fantastic for quick previews, but for production sites, we recommend initializing a standard configuration file for maximum control.\n\n### Option 2: Project Installation (Recommended)\nFor permanent projects, install `docmd` as dependency to lock your versions.\n\n```bash\n# 1. Install locally\nnpm install @docmd/core\n\n# 2. Initialize your configuration\nnpx docmd init\n\n# 3. Start developing\nnpx docmd dev\n```\n\n### Option 3: Global Installation\nInstall once and use the `docmd` command anywhere on your machine.\n\n```bash\nnpm install -g @docmd/core\n\ndocmd dev        # Start the local dev server\ndocmd build      # Generate the production static site\n```\n\n## Project Structure\n\n`docmd` keeps your repository clean. Your content lives in `docs/`, your config in `docmd.config.js`.\n\n```bash\nmy-docs/\n├── docs/                  # Your Markdown Files\n│   ├── index.md           # Homepage\n│   └── guide.md           # Content Page\n├── assets/                # Images and Custom JS/CSS\n├── docmd.config.js        # The docmd Configuration\n└── package.json           # Node.js Dependencies\n```\n\n## Configuration\n`docmd` provides a highly flexible API. Customize your site in seconds via `docmd.config.js`. Here is a robust example showing off our most powerful features:\n\n```javascript\nconst { defineConfig } = require('@docmd/core');\n\nmodule.exports = defineConfig({\n  title: 'My Project',\n  url: 'https://mysite.com',\n  src: 'docs',\n  out: 'site',\n  \n  // Enterprise Versioning\n  versions: {\n    current: 'v2', // Builds to root (/) for optimal SEO\n    all:[\n      { id: 'v2', dir: 'docs', label: 'v2.x (Latest)' },\n      { id: 'v1', dir: 'docs-v1', label: 'v1.x' }\n    ]\n  },\n\n  // Layout \u0026 UI Architecture\n  layout: {\n    spa: true,  // Enable buttery-smooth page transitions\n    header: { enabled: true },\n    sidebar: { collapsible: true },\n    \n    optionsMenu: {\n      position: 'header',\n      components: {\n        search: true,\n        themeSwitch: true\n      }\n    },\n\n    footer: {\n      style: 'minimal'\n    }\n  },\n  \n  // Custom Navigation (If not using Zero-Config)\n  navigation:[\n    { title: 'Home', path: '/', icon: 'home' },\n    {\n      title: 'Guide',\n      icon: 'book-open',\n      children:[\n        { title: 'Installation', path: '/installation' },\n        { title: 'API Reference', path: '/api' },\n      ],\n    }\n  ],\n\n  // Theme Settings\n  theme: {\n    name: 'sky',            // 'default', 'sky', 'ruby', 'retro'\n    defaultMode: 'system',  // 'light', 'dark', 'system'\n  },\n\n  // Powerful Plugins (Zero setup required)\n  plugins: {\n    search: {},\n    pwa: { themeColor: '#0097ff' },  // Makes your docs installable!\n    llms: { fullContext: true },     // Generates llms-full.txt\n    mermaid: {}\n  },\n\n  // SEO \u0026 Error Handling\n  redirects: { '/old-guide': '/installation' },\n  notFound: { title: 'Page Not Found', content: 'This page has moved.' }\n});\n```\n\n## Advanced Usage\n\n### Programmatic API\n`docmd` exports its core engine, allowing you to build documentation programmatically within your own Node.js scripts or CI/CD pipelines.\n\n```javascript\nconst { build, buildLive } = require('@docmd/core');\n\n// Trigger a standard documentation build\nawait build('./docmd.config.js', { \n  isDev: false, \n  offline: false \n});\n\n// Build the Live Editor standalone bundle\nawait buildLive(); \n```\n\n### Live Editor (`docmd live`)\n`docmd` features an isomorphic architecture. Running `npx @docmd/core live` builds a standalone web application where you can write Markdown and see the preview instantly without any server-side processing.\n\n\u003e You can also try our **[docmd live](https://live.docmd.io)** editor online.\n\n## Comparison\n\n| Feature | docmd | Docusaurus | MkDocs | Mintlify |\n| :--- | :--- | :--- | :--- | :--- |\n| **Language** | **Node.js** | React.js | Python | Proprietary |\n| **Navigation** | **Instant SPA** | React SPA | Page Reloads | Hosted SPA |\n| **Output** | **Static HTML** | React Hydration | Static HTML | Hosted |\n| **JS Payload** | **Tiny (\u003c 20kb)** | Heavy (\u003e 200kb) | Minimal | Medium |\n| **Versioning** | **Easy (Config + Auto)** | Complex (FS) | Plugin (Mike) | Native |\n| **i18n Support** | **In Pipeline** | Native | Theme-based | Beta |\n| **Search** | **Built-in (Offline)** | Algolia (Cloud) | Built-in (Lunr) | Built-in (Cloud) |\n| **PWA** | **Built-in (Plugin)** | Plugin | None | Hosted |\n| **AI Context** | **Built-in (llms.txt)** | Plugin | None | Proprietary |\n| **Setup** | **Instant (-z)** | ~15 mins | ~10 mins | ~5 mins |\n| **Cost** | **Free OSS** | Free OSS | Free OSS | Freemium |\n\n## Community \u0026 Support\n- **Contributing**: We welcome PRs! See [CONTRIBUTING.md](.github/CONTRIBUTING.md).\n- **Support**: If you find `docmd` useful, please consider [sponsoring the project](https://github.com/sponsors/mgks) or giving it a star ⭐.\n\n## License\nDistributed under the MIT License. See `LICENSE` for more information.\n\n![Website Badge](https://img.shields.io/badge/.*%20mgks.dev-blue?style=flat\u0026link=https%3A%2F%2Fmgks.dev) ![Sponsor Badge](https://img.shields.io/badge/%20%20Become%20a%20Sponsor%20%20-red?style=flat\u0026logo=github\u0026link=https%3A%2F%2Fgithub.com%2Fsponsors%2Fmgks)","funding_links":["https://github.com/sponsors/mgks"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocmd-io%2Fdocmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocmd-io%2Fdocmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocmd-io%2Fdocmd/lists"}