🏗️ Knowledge Front Base 搭建文档¶
日期: 2026-07-30
状态: ✅ 已完成
作者: Claude Assistant
📋 目录¶
1. 项目概览¶
这是一个全栈知识库项目,托管于 GitHub,并通过 Git 与本地开发环境同步。目标是构建一个全面的文档系统,记录所有技术决策、搭建流程与架构选择。
2. 技术栈¶
核心技术¶
| 类别 | 技术 | 版本 / 说明 |
|---|---|---|
| 版本控制 | Git | v2.55.0(Windows) |
| 包管理器 | pnpm | 推荐用于 monorepo |
| 运行时 Node.js | LTS 版本 | 最新稳定版 |
| 知识格式 | Markdown(.md) | 文档标准格式 |
| 编辑器 | Obsidian | 本地编辑、云同步 |
| 托管 | GitHub Pages / CDN | 免费托管方案 |
可选增强¶
| 功能 | 工具 | 收益 |
|---|---|---|
| 静态站点生成器 | Docusaurus / MkDocs | 美观的文档站点 |
| 搜索 | Algolia / Fuse.js | 全文搜索 |
| 数据库 | DuckDB + duckdb-skills | 以 SQL 查询知识库 |
| 可视化 | dataviz 技能 | 知识图谱可视化 |
| 自动化 | workflow / cron 技能 | 自动备份与维护 |
3. 搭建流程¶
第 1 步:环境检查 ✅¶
# 确认 E 盘存在且有空间
Get-PSDrive E
# 输出:E: 已用 44.44GB,可用 192.39GB ✓
# 确认 git 已安装
git --version
# 输出:git version 2.55.0.windows.3 ✓
# 确认用户配置
git config --global user.name
git config --global user.email
第 2 步:克隆仓库 ✅¶
git clone https://github.com/1079161148/knowledge-front-yuying.git E:\knowledge-front-yuying
# 提示:克隆到的是空仓库(新项目的预期情况)
第 3 步:创建初始目录结构¶
(见下方第 4 节)
第 4 步:配置 Git 忽略重要文件¶
(见配置文件中的 .gitignore)
第 5 步:初始化首批内容¶
- 创建
README.md—— 主文档 - 创建
docs/目录 —— 知识内容入口 - 创建
tech-stack/—— 记录技术决策 - 创建
setup/—— 即本文档!
4. 目录结构¶
E:\knowledge-front-yuying\
├── .git/ # 版本控制元数据(自动生成)
├── docs/ # 知识内容(Markdown 文件)
│ ├── index.md # 知识库入口
│ ├── setup/ # 搭建文档
│ └── tech-stack/ # 技术决策
├── scripts/ # 自动化脚本
│ └── sync.bat # 与 GitHub 同步
├── configs/ # 配置文件
│ └── .gitignore # Git 忽略规则
├── README.md # 项目主文档
└── CONTRIBUTING.md # 贡献指南
5. 配置文件¶
.gitignore¶
# Node.js 依赖
node/
npm-debug.log
yarn-error.lock
# 编辑器配置
.vscode/
.idea/
*.sublime-project
*.workspace
# 操作系统隐藏文件
.DS_Store
Thumbs.db
# 构建产物
dist/
build/
coverage/
site/ # MkDocs 生成的静态站点
.mkdocs/ # MkDocs 缓存
# 环境变量
.env
.env.local
.env.development
.env.production
# 日志文件
*.log
# 临时文件
*.tmp
*.temp
# 缓存目录
cache/
.tmp/
# 包管理器锁文件
pnpm-lock.yaml
yarn.lock
# Windows 缩略图缓存
Desktop.ini
# Python 虚拟环境(如使用)
__pycache__/
*.pyc
.venv/
env/
scripts/sync.bat(Windows 批处理脚本)¶
@echo off
cd /d E:\knowledge-front-yuying
echo 正在与 GitHub 同步...
git add . -A
git commit -m "Auto-sync: %date% %time%"
git push origin master
echo 同步完成!
pause
6. 后续步骤¶
立即行动¶
- ✍️ 向
docs/填充实际知识内容 - 🔍 添加搜索功能(Fuse.js 或类似方案)
- 🎨 为静态站点生成创建美观主题 / 布局
- 🤖 使用 cron / workflow 技能配置自动备份
长期目标¶
- 🔄 与 Obsidian 集成实现双向同步
- 💾 使用 DuckDB 以 SQL 查询知识库
- 📊 用 dataviz 可视化知识关联
- 🌐 部署到 GitHub Pages 对外公开访问
7. 搭建过程中使用的 Claude 技能¶
| 技能 | 用途 | 使用命令 |
|---|---|---|
| duckdb-skills | 数据库查询规划 | /duckdb-skills:... |
| dataviz | 知识可视化 | /dataviz:... |
| review | 代码 / 文档审查 | /review:... |
| workflow | 自动化规划 | /workflow:... |
| cron | 任务调度 | /cron:... |
| playwright(MCP) | Web 自动化测试 | /mcp__playwright__browser:... |
| context7(MCP) | 上下文管理 | /mcp__context7:... |
本文档在搭建过程中应要求创建,用于记录所有技术细节。