快速开始
欢迎使用 KnowBase。这里记录日常开发中的技术笔记、架构设计与踩坑经验。
本地运行
bash
# 安装依赖(首次)
npm install
# 启动本地开发服务器(默认 http://localhost:5173)
npm run docs:dev
# 构建静态站点到 .vitepress/dist
npm run docs:build
# 本地预览构建产物
npm run docs:preview日常写作流程
- 在
docs/目录下新建.md文件,比如docs/notes/my-new-note.md - 写完保存,
npm run docs:dev会热更新,浏览器即时看到效果 - 满意后提交并推送:
bash
git add .
git commit -m "docs: 新增 XXX 笔记"
git push- 稍后线上站点自动更新
目录结构
<项目根目录>/ ├── docs\ # 所有 Markdown 内容 │ ├── index.md # 首页(layout: home) │ ├── guide\ # 指南 │ ├── notes\ # 笔记 │ └── public\ # 原样拷贝到站点根目录的静态文件 ├── .vitepress
│ └── config.mjs # 站点配置(导航、侧边栏、搜索等) ├── package.json └── .gitignore
::: tip 关于 public 目录
放在 `docs/public/` 里的文件会被**原封不动**复制到站点根目录,
适合放独立 HTML、图片、PDF 等静态资源。
:::
## 常用配置修改
改导航、侧边栏、页脚:编辑 `.vitepress/config.mjs`
更多用法见 [Markdown 写作指南](/notes/writing)。