开发指南

开发环境搭建

前置要求

• Node.js 18+
• npm 9+
• Git

项目结构

jddoc/
├── .vitepress/         # VitePress配置
├── docs/              # 文档内容
├── login.md           # 登录页面
├── index.md           # 首页
└── package.json       # 项目配置

开发流程

1. 克隆项目
2. 安装依赖：npm install
3. 启动开发服务器：npm run dev
4. 访问：http://localhost:3000

文档编写规范

Markdown 规范

• 使用标准 Markdown 语法
• 标题层级清晰
• 代码块使用 包裹
• 图片使用相对路径

内容结构

• 每个文档应该有明确的主题
• 内容应该逻辑清晰，层次分明
• 重要内容使用加粗或强调

部署指南

构建

npm run build

部署

构建产物位于 .vitepress/dist 目录，可以部署到任何静态网站托管服务。