Knowledge Base (WHY の 自留地)
在线查看:
技术栈及亮点:
- 基于
vitepress和UnoCSS Docs并适当改造 - 自动生成
nav和sidebar至.generated/navbar.json和.generated/sidebar.json nolebase系列插件- @nolebase/vitepress-plugin-highlight-targeted-heading 点击标题高亮展示之
- @nolebase/vitepress-plugin-inline-link-preview 鼠标悬停预览内部链接, 效果同
Obsidian或Notion - @nolebase/vitepress-plugin-enhanced-readabilities
- @nolebase/vitepress-plugin-git-changelog 由
git仓库信息获取相关信息并为每个md文件自动生成Contributors和Changelog
脚本命令
使用 pnpm 安装依赖:
bash
pnpm i本地开发调试:
bash
pnpm docs:dev打包:
bash
pnpm docs:build预览:
bash
pnpm docs:preview格式化:
bash
pnpm prettier自动生成 navbar 和 sidebar:
bash
# 运行项目时会自动运行 ./vitepress/utils/auto-generate.js
# 这里只是提供另外一种不运行项目也可运行对应 ./vitepress/utils/auto-generated.js 的方式
# 运行成功后可查看 .generated/navbar.json 和 .generated/sidebar.json
pnpm generate:auto由 git commit 生成 heatmap:
bash
# 文件位于 .generated/heatmap.json
pnpm generate:heatmapThanks to
部署
GitHub Pages
Vercel
Vercel构建徽标关闭
preview build:仅监听
main分支变动: 判断VERCEL_GIT_COMMIT_REF环境变量值是否等于main即可
注意, 须在 Vercel 后台添加环境变量:
dotenv
# 这将使 `.vitepress/config.ts` 中 `base` 为 `/`
VITE_BASE_ENV="development"Netlify
注意, 须在 Netlify 后台添加环境变量:
dotenv
# 这将使 `.vitepress/config.ts` 中 `base` 为 `/`
VITE_BASE_ENV="development"Docker
构建镜像:
bash
docker build -t knowledge-base .运行:
bash
docker run -itd -p 8002:80 --name knowledge-base knowledge-base浏览器输入 http://localhost:8002/knowledge-base 即可查看
使用 deploy.sh 一键运行:
bash
# 避免 bash/zsh: permission denied: ./deploy.sh
# cd 至当前项目所在根目录
chmod 777 deploy.sh
# 运行 deploy.sh
# 运行成功后查看 http://localhost:8002/knowledge-base
./deploy.shContributors
why