第一步，克隆仓库
git clone --single-branch --branch master https://github.com/Phil-Fan/Notebook.git第二步，安装 uv
# 方法1: 使用 Homebrew（推荐）
brew install uv
# 方法2: 使用 wget 安装
wget -qO- https://astral.sh/uv/install.sh | sh第三步，安装依赖
cd Phil-Fan.github.io
uv sync第四步，启动网站
make serve打开http://127.0.0.1:8000即可查看网站
项目提供了 Makefile 来简化常用操作：
| 命令 | 说明 |
|---|---|
make help |
显示所有可用命令 |
make serve |
启动 Mkdocs 开发服务器 |
make format |
格式化所有文件（Markdown + Python） |
make format-md |
格式化 Markdown 文件 |
make format-py |
格式化 Python 文件 |
make install-dev |
安装开发依赖 |
make build |
构建 Mkdocs 站点 |
make clean |
清理构建文件 |
make check-tools |
检查格式化工具是否已安装 |
示例：
# 查看帮助
make help
# 格式化所有文件
make format
# 启动开发服务器
make serve
# 构建静态站点
make build项目配置了 Claude Code 的自定义 slash commands，可以在使用 Claude Code 时快速执行常见任务。
| 命令 | 说明 |
|---|---|
/add [内容] |
添加内容到知识库 |
/check-markdown [路径] |
检查 Markdown 文件格式 |
/understand |
理解这个知识库仓库的结构 |
示例：
# 添加新知识点到知识库
/add 在 Python 中使用 async/await 处理并发
# 检查特定文件的格式
/check-markdown docs/AI/LLM/Engineer/01-LLMs.md
# 检查整个项目的格式
/check-markdown
# 了解仓库结构
/understand
配置了 PostToolUse hook，每次使用 Write 或 Edit 工具后会自动运行格式化：
- markdownlint：Markdown 语法检查和修复
- autocorrect：中英文格式自动修正
- ruff：Python 代码检查和修复
/add 命令会按照以下规则自动归档内容：
- 目录分类：自动判断内容所属的知识分类（AI/Math/Robotics/CS/Tools/Project/Class/Interest）
- 文件定位：搜索现有文件或创建新文件
- 格式化：按照项目规范格式化内容
- 索引更新：自动更新 index.md 和 mkdocs.yml
- 格式检查：运行 formatter 确保格式正确
欢迎贡献！欢迎贡献！欢迎贡献！
经过重构以后，仓库变小了很多，现在只有 20MB 左右，应该不会对大家的使用造成影响
- 如果想要贡献，请先 fork 仓库，然后创建一个新分支，提交你的修改，然后创建一个 pull request
- 如果你需要添加图片，使用
asset/{filename}.assets/{x}.{y}来存放图片，其中x是图片名，y是图片格式，比如asset/image.assets/1.png，合并的时候我会处理图床问题
👤 PhilFan
Give a ⭐️ if this notebook helps you!