docmd
starsforks
How to install docmd?
docmd-io/docmd
$git clone https://github.com/docmd-io/docmd<br/>
README.md
| 1 | <div align="right"> |
| 2 | <sup> |
| 3 | <b>EN</b> | <a href="./README.es.md">ES</a> | <a href="./README.de.md">DE</a> | <a href="./README.ja.md">日本語</a> | <a href="./README.fr.md">FR</a> | <a href="./README.zh.md">中文</a> |
| 4 | </sup> |
| 5 | </div> |
| 6 | |
| 7 | <div align="center"> |
| 8 | |
| 9 | <a href="https://docmd.io"> |
| 10 | <picture> |
| 11 | <source media="(prefers-color-scheme: dark)" srcset="https://github.com/docmd-io/docmd/blob/main/packages/ui/assets/images/docmd-logo-dark.png?raw=true" /> |
| 12 | <source media="(prefers-color-scheme: light)" srcset="https://github.com/docmd-io/docmd/blob/main/packages/ui/assets/images/docmd-logo-dark.png?raw=true" /> |
| 13 | <img src="https://github.com/docmd-io/docmd/blob/main/packages/ui/assets/images/docmd-logo-dark.png?raw=true" alt="docmd" width="210" /> |
| 14 | </picture> |
| 15 | </a> |
| 16 | |
| 17 | <br/> |
| 18 | |
| 19 | <p><b>Production-ready documentation from Markdown, in seconds.</b><br/>Zero config. AI-native. Built for developers.</p> |
| 20 | |
| 21 | <p> |
| 22 | <a href="https://www.npmjs.com/package/@docmd/core"><img src="https://img.shields.io/npm/v/@docmd/core.svg?style=flat-square&color=CB3837" alt="npm version"></a> |
| 23 | <a href="https://www.npmjs.com/package/@docmd/core?activeTab=versions"><img src="https://img.shields.io/npm/dm/@docmd/core.svg?style=flat-square&color=38bd24" alt="monthly downloads"></a> |
| 24 | <a href="https://github.com/docmd-io/docmd"><img src="https://img.shields.io/github/stars/docmd-io/docmd?style=flat-square&logo=github" alt="GitHub stars"></a> |
| 25 | <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=A31F34" alt="license"></a> |
| 26 | </p> |
| 27 | |
| 28 | <h4> |
| 29 | <a href="https://docmd.io">Website</a> · |
| 30 | <a href="https://docs.docmd.io">Documentation</a> · |
| 31 | <a href="https://live.docmd.io">Live Editor</a> · |
| 32 | <a href="https://github.com/docmd-io/docmd-skills">Agent Skills</a> · |
| 33 | <a href="https://github.com/docmd-io/docmd/issues">Report a Bug</a> |
| 34 | </h4> |
| 35 | |
| 36 | <br/> |
| 37 | |
| 38 | <a href="https://docs.docmd.io"> |
| 39 | <img width="820" alt="docmd default theme — light and dark mode preview" src="https://raw.githubusercontent.com/docmd-io/docmd/refs/heads/main/assets/docmd-cover.webp" /> |
| 40 | </a> |
| 41 | |
| 42 | <br/><br/> |
| 43 | |
| 44 | </div> |
| 45 | |
| 46 | ## Quick Start |
| 47 | |
| 48 | Run docmd in any folder with Markdown files — no install needed: |
| 49 | |
| 50 | ```bash |
| 51 | npx @docmd/core dev |
| 52 | ``` |
| 53 | |
| 54 | <details> |
| 55 | <summary><b>Opens at <code>http://localhost:3000</code></b></summary><br> |
| 56 | |
| 57 | ```bash |
| 58 | _ _ |
| 59 | _| |___ ___ _____ _| | |
| 60 | | . | . | _| | . | |
| 61 | |___|___|___|_|_|_|___| |
| 62 | |
| 63 | v1.x.x |
| 64 | |
| 65 | ┌─ Build |
| 66 | │ Engine JS |
| 67 | │ Source docs/ |
| 68 | │ Output site/ |
| 69 | │ Versions 2 (06, 05) |
| 70 | │ Locales 7 (en, hi, zh, es, de, ja, fr) |
| 71 | └────────────────────────────────────────────────────────── |
| 72 | ┌─ Data Indexing |
| 73 | │ [ DONE ] Syncing git metadata |
| 74 | │ [ DONE ] Building semantic search index (multi-version) |
| 75 | └────────────────────────────────────────────────────────── |
| 76 | ┌─ Publishing |
| 77 | │ [ DONE ] Generated robots.txt |
| 78 | │ [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages) |
| 79 | │ [ DONE ] Generated sitemap |
| 80 | │ [ DONE ] Generating LLMs context files |
| 81 | └────────────────────────────────────────────────────────── |
| 82 | |
| 83 | ⬢ Initial build completed in 1.2s. |
| 84 | |
| 85 | ┌─ Watching |
| 86 | │ Source ./docs |
| 87 | │ Config ./docmd.config.json |
| 88 | │ Assets ./assets |
| 89 | └────────────────────────────────────────────────────────── |
| 90 | ┌─ Development Server Running |
| 91 | │ Local Access http://127.0.0.1:3000 |
| 92 | │ Network Access http://192.168.1.6:3000 |
| 93 | │ Serving from ./site |
| 94 | └────────────────────────────────────────────────────────── |
| 95 | ``` |
| 96 | </details> |
| 97 | |
| 98 | <p align="center"> |
| 99 | <img alt="docmd dev server preview" width="820" src="https://docmd.io/assets/images/dev-preview.gif"> |
| 100 | </p> |
| 101 | |
| 102 | Navigation is generated from your file structure. No config file, no frontmatter required, no framework to learn. |
| 103 | |
| 104 | **When you're ready to ship:** |
| 105 | |
| 106 | ```bash |
| 107 | npx @docmd/core build |
| 108 | ``` |
| 109 | |
| 110 | T |
People who liked this also viewed
6 picksType
- markitdown-mcp📄 Professional MCP server for converting 29+ file formats to Markdown - Perfect for Claude Desktop and AI workflows!MCP ServersJun 2026
- python-mcp-server-client支持查询主流agent框架技术文档的MCP server（支持stdio和sse两种传输协议）, 支持 langchain、llama-index、autogen、agno、openai-agents-sdk、mcp-doc、camel-ai 和 crew-aiMCP ServersMay 2025
- kordoc모두 파싱해버리겠다 — HWP·HWPX·PDF·Office 문서를 Markdown으로. 양식 자동 채우기와 신구대조를 갖춘 CLI·MCP 서버 | Convert Korean documents (HWP, HWPX, PDF, Office) to Markdown — CLI and MCP server with form filling and diffMCP ServersJul 2026
- PDFMathTranslate[EMNLP 2025 Demo] PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译，支持 Google/DeepL/Ollama/OpenAI 等服务，提供 CLI/GUI/MCP/Docker/ZoteroMCP ServersMay 2026
- jdocmunch-mcpThe leading, most token-efficient MCP server for documentation exploration and retrieval via structured section indexingMCP ServersJul 2026
- Keenable Web SearchDocs: https://docs.keenable.ai/mcp-server Keenable is a free, remote MCP server that gives agents access to the web index. Search the web with ranked results and date/site filters, then fetch any indexed page as clean markdown. Works out oMCP Serversrecently
