doc
个人知识库。按语言 → 项目/专题 → 内容类别三级组织。
doc/
├── README.md ← 你在这里
├── AI/ ← 主题区:跨语言的 AI 知识图谱(AI 为最外层,见下方说明)
└── <语言>/ ← ① 按语言分:flutter / vue / react / node ...
└── <项目或专题>/ ← ② 按项目分:一个项目一个目录
├── README.md ← 专题入口:背景、文档清单、阅读顺序
└── <类别>/ ← ③ 按类别分:见下方规范
└── NN-标题.md关于
AI/AI 不属于任何一种语言,因此作为顶层主题区与语言目录并列,不套用下面的七类编号。 其内部按"从底层到应用"分为 12 个板块,编号
00~11表示阅读顺序,另有一份易变信息附录。 入口见 AI/README.md。
分类规范
第二层的类别目录统一按内容性质划分,编号固定为以下七类(不需要的类别不建目录,保留编号跳跃以便定位):
| 目录 | 放什么 | 举例 |
|---|---|---|
01-入门导览 | 总索引、学习路线、快速上手 | 学习路线图、环境搭建 |
02-语言基础 | 该语言本身的语法与特性 | Dart 语法、TS 类型体操 |
03-框架基础 | 框架核心概念与通用机制 | Flutter 渲染原理、React Hooks |
04-项目架构 | 具体项目的分层、状态管理、数据链路 | 目录地图、Riverpod、数据层 |
05-项目实战 | 端到端的功能实现记录 | 页面开发、分页列表、路由 |
06-平台能力 | 与操作系统/第三方服务对接 | 国际化、权限、推送 |
07-工程化 | 构建、测试、调试、规范 | 构建脚本、调试技巧、速查表 |
文件命名:NN-标题.md,NN 为两位序号,表示阅读顺序(跨类别全局递增,便于按序通读)。
现有内容
| 层级 | 专题 | 说明 |
|---|---|---|
| AI | — | AI 知识图谱(13 篇):从基础概念、模型、Agent、工程化到算力、合规、学习路径,按"底层→应用"分为 12 个板块 + 1 份速查附录 |
| flutter | haierenergy-onboarding | HaierEnergy Flutter 项目学习文档(18 篇,面向前端转 Flutter 初学者) |
新增一个专题
- 在对应语言目录下建
<项目名>/ - 里面建
README.md(说明背景、文档清单、阅读顺序) - 按上表建类别目录,放入
NN-标题.md - 回到本文件,在「现有内容」表格里加一行
新增一个顶层主题
跨语言的主题(如 AI)直接在根目录建大写目录,内部自带 README.md 与编号文档, 不套用语言目录下七类规范,并在本文件的结构图中登记说明。
本站即知识库站点(VitePress)
源码在 dev 分支,构建产物(.vitepress/dist)推到 main 分支,由 Gitee Pages 托管,多端(手机/电脑/平板)可访问、带全文搜索。
| 分支 | 角色 | 内容 |
|---|---|---|
dev | 开发分支 | .md 文档 + .vitepress/config.ts + package.json |
main | 发布分支 | VitePress 构建出的静态 html/css/js(Gitee Pages 读取) |
本地预览 / 构建
bash
npm install # 首次安装依赖
npm run docs:dev # 本地预览(默认 http://localhost:5173/doc/)
npm run docs:build # 构建产物到 .vitepress/dist部署(推到 main 供 Gitee Pages)
bash
bash deploy.sh # 自动 build + 推送 main 分支部署后到 Gitee 仓库 → 服务 → Gitee Pages → 部署分支选 main → 更新,即可通过 https://mr_xiao_bai.gitee.io/doc/ 访问。
新增一篇文档后
- 在对应类别目录放
NN-标题.md - 在
.vitepress/config.ts的sidebar/nav里加一条链接(绝对路径,以/doc/为基准) npm run docs:dev本地确认,再bash deploy.sh