DocGen

一个简单的文档生成工具，将 Markdown 文档转换为静态网站。

功能特性

• 📁 自动扫描 - 递归扫描目录结构
• 📝 Markdown 支持 - 完整的 Markdown 渲染和 frontmatter
• 🔍 内置搜索 - 全文搜索功能
• 🎨 代码高亮 - 基于 Shiki 的语法高亮
• ⚡ 热更新 - 文件监听和自动刷新
• 📱 响应式 - 支持移动端和桌面端

安装

npm install -g docgen

或本地安装：

npm install
npm run build
npm link

使用方法

开发模式

启动开发服务器，支持热更新：

docgen ./docs
# 或指定端口
docgen ./docs --port 3001

构建静态站点

生成可部署的静态文件：

docgen build ./docs --output ./dist

预览构建结果

预览已构建的站点：

docgen preview --output ./dist

目录结构

docs/
├── getting-started/
│   ├── README.md       # 目录首页
│   ├── installation.md
│   └── quick-start.md
├── guides/
│   ├── README.md
│   └── advanced.md
└── api/
    └── README.md

文档格式

每个 Markdown 文件支持 frontmatter：

---
title: 页面标题
description: 页面描述
tags: ["tag1", "tag2"]
---

# 页面内容

这里是 Markdown 内容...

路由规则

• README.md → 目录路径（如 /getting-started）
• SKILL.md → 目录路径
• 其他 .md 文件 → 保留文件名（如 /guides/advanced）

开发

# 安装依赖
npm install

# 构建 CLI
npm run build

# 类型检查
npm run typecheck

# 代码检查
npm run lint

# 本地测试
npx tsx src/cli/index.ts dev --dir ./my-docs

技术栈

• 后端: Node.js, TypeScript, Commander.js
• 前端: Vue 3, Vite, Vue Router
• 解析: gray-matter, markdown-it, Shiki
• 监听: chokidarvirtual-goods-trading-platform ❯ npx docmk /Users/pan/Downloads/virtual-goods-trading-platform/my-docs -p 5555 Need to install the following packages: [email protected] Ok to proceed? (y)

🚀 Starting DocGen development server... 📁 Scanning source directory: /Users/pan/Downloads/virtual-goods-trading-platform/my-docs ✅ Found 3 directories (!) Could not auto-determine entry point from rollupOptions or html files and there are no explicit optimizeDeps.include patterns. Skipping dependency pre-bundling. 🎉 Dev server running at http://localhost:5555

• 构建: tsup找不到 localhost 的网页 找不到与以下网址对应的网页：http://localhost:5555/ HTTP ERROR 404

许可证

MIT