用Docmd让Markdown秒变精美网页

开源神器！ 一键生成文档网站，用Docmd让Markdown秒变精美网页

项目简介

Docmd (docmd) 是一款基于 Node.js 的命令行工具，用于从标准 Markdown 文件生成轻量级静态文档网站。 它遵循“内容至上”的理念，强调编写与阅读的高效和简洁体验。

🔗 在线示例：docmd.mgks.dev该网站使用 Docmd 构建，同时作为官方文档和实时演示。

主要功能

  • 📝 原生 Markdown 支持：兼容标准 Markdown 与 YAML frontmatter
  • 🎨 多主题与暗色模式：内置语法高亮与多种样式方案
  • 🚀 轻量与快速：纯静态网站生成，依赖最少的 JavaScript
  • 🧩 自定义组件：支持提示框、卡片、步骤等扩展元素
  • 🔌 内置插件：集成 SEO、统计分析、站点地图等功能
  • 🎭 自由页面：可创建无样式的独立页面，完全控制 HTML 内容
  • 🖌️ 自定义样式与脚本：支持在 frontmatter 中直接添加 CSS/JS
  • 💻 简洁 CLI 命令：提供 init、dev、build 等核心命令
  • 🌐 自由部署：可在 GitHub Pages、Netlify、Vercel 等任意平台发布

安装

通过 npm 安装

1
2
3
4
5
# 全局安装（推荐）
npm install -g @mgks/docmd

# 项目内安装
npm install --save-dev @mgks/docmd

快速开始

1
2
3
4
5
6
7
8
# 初始化新项目
docmd init

# 启动开发服务器
docmd dev

# 构建生产版本
docmd build

更多内容请访问 官方文档。

项目地址

https://github.com/mgks/docmd/blob/main/README.md