Appearance
知识库门户
多项目知识库统一入口 · 一个项目一套独立目录 · 互不干扰
这是一个 VitePress 知识库门户程序的骨架,不含任何业务内容。 各项目的文档由你们自己创建,新增项目见 总览 · 使用说明。
项目导航
| 项目 | 定位 | 文档量 |
|---|---|---|
| 示例项目 | 演示目录结构、侧边栏生成与排序规则(可直接删) | 2 篇 |
进入任一项目后,左侧目录树只显示该项目的文档,互不干扰。
一分钟上手
| 想做 | 怎么做 |
|---|---|
| 新增一个项目 | 在仓库根建目录 → 在 hub-v2/.vitepress/config.mts 的 ENTRIES 加一行 |
| 写一篇文档 | 在项目目录里新建 .md,首行写 # 标题(前端加 order: 序号 控制排序) |
| 本地预览 | bash run-service.sh(构建 + 起服务,端口 5090) |
| 部署上线 | 见 README.md(Docker 静态托管,宿主无需装 Node) |
目录约定
| 路径 | 说明 |
|---|---|
hub-v2/ | 门户程序:导航注册表、侧边栏自动生成、主题、搜索、Mermaid 渲染 |
overview/ | 总览区(跨项目的顶层说明,不属于任何单个项目) |
example/ | 示例项目(可删除,删完请同步删掉 ENTRIES 里那一行) |
public/brand/ | 站点图标与 Logo(换成贵司的即可) |