🧭 工具简介:让 Markdown 文档秒变网站
Docmd 是一款专为开发者设计的静态文档生成工具,能够将普通的 Markdown 文件瞬间转化为优雅、响应式的文档网站。它的理念是“Zero Clutter, Just Content”——只保留内容本身,让文档阅读更纯粹。整个工具基于 Node.js 开发,通过命令行即可实现从初始化、开发到构建部署的完整流程,无需复杂配置,轻松上手。
✨ 核心功能亮点
📝 Markdown 驱动
原生支持 Markdown 与 YAML Frontmatter,只需专注内容编写即可自动生成整洁的 HTML 页面。
🎨 多主题与暗色模式
内置多款主题与自动切换的亮/暗模式,并支持语法高亮,让代码展示更清晰。
🚀 极速与轻量
采用静态生成架构,几乎无需 JS,加载速度快且性能稳定。
🧩 丰富组件与插件
支持提示框、卡片、步骤等自定义组件,内置 SEO、Analytics、Sitemap 等实用插件,帮助文档在搜索引擎中获得更好曝光。
💻 极简命令行体验
三条命令即可完成从项目创建到上线的全过程:
docmd init # 初始化项目
docmd dev # 启动本地开发服务
docmd build # 生成生产版本
🌐 一键部署
生成的静态网站可自由托管到 GitHub Pages、Vercel、Netlify 等平台,支持自定义域名。
🧠 适用场景
- 技术项目文档生成
- 开源项目说明书
- Markdown 笔记网站
- 个人知识库与团队 Wiki
无论你是开发者、开源维护者,还是喜欢用 Markdown 记录的创作者,Docmd 都能让你的文字以最美的方式呈现。
📦 安装方式
通过 npm 全局安装即可快速使用:
npm install -g @mgks/docmd
或在项目中本地安装:
npm install --save-dev @mgks/docmd
更多示例与文档可访问官网 👉 https://docmd.mgks.dev
源码托管于 GitHub 👉 https://github.com/mgks/docmd
© 版权声明
文章版权归作者所有,未经允许请勿转载。
相关文章
暂无评论...