Docmd：基于 Markdown 快速构建极简静态文档站的部署指南

Docmd：将 Markdown 快速转化为极简文档网站

Docmd 是一款基于 Node.js 开发的静态文档生成工具，旨在践行“Zero Clutter, Just Content”的理念。它能将纯文本的 Markdown 文件高效转化为响应式、美观的文档网站，让开发者无需在复杂的配置上浪费时间，将精力完全集中在内容创作上。

Core Functions

• Markdown 原生驱动： It supports Markdown syntax and YAML Frontmatter, enabling automated HTML conversion of content.
• 轻量化架构： 采用静态生成方案，极大地减少了 JS 依赖，确保页面加载速度快且性能稳定。
• 视觉体验： It has multiple built-in themes, supports code syntax highlighting and automatic switching between light and dark modes.
• 增强组件与 SEO： It offers customizable components such as tooltips, cards, and steps; and includes built-in Sitemap, Analytics, and SEO plugins to improve search engine visibility.
• Flexible deployment: The generated static files can be seamlessly hosted on Vercel, Netlify, or GitHub Pages, and support binding custom domains.

快速上手

1. 安装工具

可通过 npm 进行全局安装或项目本地安装：

# 全局安装 npm install -g @mgks/docmd # Local development dependency installation npm install --save-dev @mgks/docmd

2. 核心指令

仅需三条命令即可完成从初始化到发布的完整链路：

docmd init # 初始化项目配置 docmd dev # 启动本地预览服务 docmd build # 构建生产环境静态版本 

适用场景

• 技术文档： 快速构建 API 文档、产品说明书或开源项目 Readme 扩展页。
• 知识管理： 将个人 Markdown 笔记或团队内部 Wiki 转化为可在线访问的网站。
• 内容创作： 适合追求极简风格、不希望被复杂 CMS 干扰的创作者。

相关资源

官网体验：docmd.mgks.dev
GitHub 源码：github.com/mgks/docmd