快速开始
本章节将帮助您快速上手使用知识库。
安装
首先,确保您已安装 Node.js (版本 16 或更高)。
然后,克隆仓库并安装依赖:
bash
# 克隆仓库
git clone https://github.com/your-username/your-repo.git
cd your-repo
# 安装依赖
npm install
# 或者使用 pnpm
pnpm install本地开发
启动本地开发服务器:
bash
npm run dev
# 或者使用 pnpm
pnpm dev现在您可以在浏览器中访问 http://localhost:5173 查看网站。
添加新内容
要添加新内容,只需在相应目录下创建 Markdown 文件即可。例如,要在指南中添加新页面:
- 在
guide目录下创建新的 Markdown 文件,如new-page.md - 在文件开头添加 frontmatter(可选):
md
---
title: 新页面标题
description: 页面描述
---
# 新页面内容
这里是新页面的内容...- 在
.vitepress/config/sidebar.ts中添加新页面的链接
构建
要构建生产版本,运行:
bash
npm run build
# 或者使用 pnpm
pnpm build构建后的文件将位于 .vitepress/dist 目录中。
部署
您可以将构建后的文件部署到任何静态网站托管服务,如 GitHub Pages、Netlify、Vercel 等。
GitHub Pages 部署示例
- 在
package.json中添加部署脚本:
json
{
"scripts": {
"deploy": "gh-pages -d .vitepress/dist"
}
}- 安装
gh-pages包:
bash
npm install -D gh-pages
# 或者使用 pnpm
pnpm add -D gh-pages- 运行部署命令:
bash
npm run deploy
# 或者使用 pnpm
pnpm deploy