Docmd : Guide de déploiement pour créer rapidement un site web minimaliste de documents statiques basé sur Markdown

Docmd : Un site web permettant de convertir rapidement du Markdown en documents minimalistes.

Docmd est un outil de génération de documentation statique développé avec Node.js, qui incarne la philosophie « Zéro superflu, que du contenu ». Il transforme efficacement les fichiers Markdown en sites web de documentation responsifs et esthétiques, libérant ainsi les développeurs des configurations complexes et leur permettant de se concentrer pleinement sur la création de contenu.

核心功能

• Markdown 原生驱动： 支持 Markdown 语法与 YAML Frontmatter，实现内容的自动化 HTML 转换。
• 轻量化架构： 采用静态生成方案，极大地减少了 JS 依赖，确保页面加载速度快且性能稳定。
• Expérience visuelle : 内置多种主题，支持代码语法高亮以及自动切换的亮 / 暗模式。
• Composants améliorés et référencement naturel : Il offre des composants personnalisables tels que des infobulles, des cartes et des étapes ; et comprend des plugins intégrés de plan de site, d'analyse et de référencement pour améliorer la visibilité sur les moteurs de recherche.
• Déploiement flexible : 生成的静态文件可无缝托管至 Vercel、Netlify 或 GitHub Pages，并支持绑定自定义域名。

快速上手

1. 安装工具

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

# 全局安装 npm install -g @mgks/docmd # 本地开发依赖安装  npm install --save-dev @mgks/docmd

2. 核心指令

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

docmd init # 初始化项目配置 docmd dev # Démarrer le service de prévisualisation local docmd build # 构建生产环境静态版本 

Scénarios applicables

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

相关资源

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