1.3 KiB
1.3 KiB
CLAUDE.md — kb 维护说明
⚠️ 最重要:敏感信息
kb 内容会被部署到公网,禁止包含任何敏感信息,包括但不限于:
- 公网 IP 地址
- 密码、API Key、Token
- 加密密钥(私钥、公钥、UUID、ShortID 等)
- SSH 密钥路径或内容
- VPN/代理服务的连接凭据(如 Shadowrocket 配置)
- 路由器/设备管理密码
- 任何可用于攻击服务器或网络的信息
技术文档只保留:架构、方法、命令模板、已知问题、解决思路。具体 IP/密钥/密码用占位符(如 <VPS IP>)代替或直接删除。
维护方式
- 用户:kurihada,主要口述内容,由 Claude 完成写作
- Claude:负责写作、排版、组织文件结构、更新导航
- 语言:简体中文
技术栈
- MkDocs Material 构建
- 源文件:
docs/下的 Markdown - 构建输出:
site/(已在 .gitignore 中忽略) - 配置:
mkdocs.yml
文件组织
- 每个分类一个目录,index.md 作为分类概览
- 具体主题拆成独立
.md文件,放在对应分类目录下 assets/放图片等附件- 新增文件后需同步更新
mkdocs.yml的nav:部分
每次编辑后
cd ~/kb && mkdocs build # 重新构建 site/
git add -A && git commit -m "描述改动"