diff --git a/CLAUDE.md b/CLAUDE.md index 57ab0db..818b154 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,8 +1,8 @@ -# CLAUDE.md — kb 维护说明 +# CLAUDE.md — notebook 维护说明 ## ⚠️ 最重要:敏感信息 -kb 内容会被部署到公网,**禁止包含任何敏感信息**,包括但不限于: +知识库内容会被部署到公网,**禁止包含任何敏感信息**,包括但不限于: - 公网 IP 地址 - 密码、API Key、Token - 加密密钥(私钥、公钥、UUID、ShortID 等) @@ -36,6 +36,6 @@ kb 内容会被部署到公网,**禁止包含任何敏感信息**,包括但 ## 每次编辑后 ```bash -cd ~/kb && mkdocs build # 重新构建 site/ +cd ~/notebook && mkdocs build # 重新构建 site/ git add -A && git commit -m "描述改动" ``` diff --git a/docs/index.md b/docs/index.md index 98d291c..106e981 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,6 +39,6 @@ comments: false ## 🛠 本站说明 - 基于 [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) 构建 -- 所有内容为纯 Markdown 文件,存储在 `~/kb/docs/` +- 所有内容为纯 Markdown 文件,存储在 `~/notebook/docs/` - Claude 协助维护和更新内容 - 评论系统 [Artalk](技术/artalk评论系统.md) 自托管,数据存储在本站服务器 diff --git a/docs/技术/artalk评论系统.md b/docs/技术/artalk评论系统.md index 869f85d..094042f 100644 --- a/docs/技术/artalk评论系统.md +++ b/docs/技术/artalk评论系统.md @@ -1,6 +1,6 @@ # Artalk 评论系统部署 -> 为 kb 接入自托管评论系统。Artalk v2.9.1:Go 后端 + SQLite,Docker 一键部署,前端 ~40KB,完全自托管无外部依赖。 +> 为知识库接入自托管评论系统。Artalk v2.9.1:Go 后端 + SQLite,Docker 一键部署,前端 ~40KB,完全自托管无外部依赖。 --- @@ -39,7 +39,7 @@ 3. **中文社区最强**:开发者是中国人,文档完整,中文 issue 响应快 4. **前端最轻**:~40KB 的 JS,对页面加载速度几乎没有影响 -Walie 和 Twikoo 也都是优秀项目,功能丰富度甚至略超 Artalk。但 kb 这种低流量个人站点,**省资源 + 零维护**的优先级远高于功能数量,Artalk 最合适。 +Walie 和 Twikoo 也都是优秀项目,功能丰富度甚至略超 Artalk。但 知识库这种低流量个人站点,**省资源 + 零维护**的优先级远高于功能数量,Artalk 最合适。 --- @@ -59,7 +59,7 @@ graph LR Artalk --> SQLite ``` -- Artalk 后端和 kb 站点部署在同一台服务器 +- Artalk 后端和 知识库站点部署在同一台服务器 - Caddy 将 `/artalk*` 路径反代到 Artalk 容器(自动去除 `/artalk` 前缀) - 前端 JS/CSS 同域加载 `/artalk/dist/`,完全自托管无跨域问题 diff --git a/docs/技术/mkdocs部署.md b/docs/技术/mkdocs部署.md index 74c4014..b6a39f8 100644 --- a/docs/技术/mkdocs部署.md +++ b/docs/技术/mkdocs部署.md @@ -8,7 +8,7 @@ ```mermaid graph LR - Repo["~/kb Git 仓库"] + Repo["~/notebook Git 仓库"] Build["mkdocs build"] Site["kb/site/ 静态文件"] Caddy["Caddy Docker
caddy:alpine"] @@ -49,7 +49,7 @@ markdown_extensions: ### 1.2 目录结构 ``` -~/kb/ +~/notebook/ ├── mkdocs.yml # 站点配置 ├── docs/ # Markdown 源文件 │ ├── index.md @@ -72,7 +72,7 @@ markdown_extensions: ### 2.1 本地构建 ```bash -cd ~/kb && mkdocs build +cd ~/notebook && mkdocs build ``` 输出到 `site/` 目录,耗时 < 1 秒。 @@ -88,7 +88,7 @@ mkdocs serve -a 0.0.0.0:8000 ### 2.3 Git 工作流 ```bash -cd ~/kb +cd ~/notebook mkdocs build # 构建 git add -A git commit -m "描述改动" # 提交 Markdown 源码 @@ -126,7 +126,7 @@ services: volumes: - ./Caddyfile:/etc/caddy/Caddyfile:ro - ./data:/data # TLS 证书存储 - - /home/kurihada/kb/site:/srv/mkdocs:ro # kb 静态文件 + - /home/kurihada/notebook/site:/srv/mkdocs:ro # kb 静态文件 networks: nginx: @@ -139,7 +139,7 @@ networks: cd ~/docker/caddy && docker compose up -d ``` -启动前确认 `~/kb/site/` 目录存在(需先执行过 `mkdocs build`),否则 bind mount 会创建一个空目录导致 404。 +启动前确认 `~/notebook/site/` 目录存在(需先执行过 `mkdocs build`),否则 bind mount 会创建一个空目录导致 404。 ### 3.4 Caddyfile 中 kb 的配置 @@ -192,7 +192,7 @@ docker exec caddy caddy reload --config /etc/caddy/Caddyfile # 零停机 4. (无需重启 Caddy) # site/ 通过 bind mount 实时生效 ``` -> 因为 Caddy 通过 `bind mount` 直接读取 `~/kb/site/`,`mkdocs build` 后变更即时生效,无需重启任何服务。 +> 因为 Caddy 通过 `bind mount` 直接读取 `~/notebook/site/`,`mkdocs build` 后变更即时生效,无需重启任何服务。 --- @@ -208,7 +208,7 @@ mkdocs build # 确认构建无报错 ### 检查构建状态 ```bash -cd ~/kb && mkdocs build --verbose +cd ~/notebook && mkdocs build --verbose ``` ### DNS 与 TLS