前置条件
- node 版本 >= 18.18.0
- pnpm 版本 > 8.1.0
安装
克隆仓库
登录 Github 账号，打开 lxchapu/astro-gyoza，点击右上角的 Fork 按钮，将仓库克隆到你自己的账号下。
复制这个仓库的地址，打开终端，使用 git clone 命令将仓库克隆到本地。
本项目推荐使用 pnpm 作为你的包管理器，如果你还没有安装 pnpm，请先安装 pnpm。
安装依赖
sh
cd astro-gyoza
pnpm install
命令介绍
本地运行
sh
pnpm dev
打包静态文件
sh
pnpm build
本地预览
sh
pnpm preview
配置项
本项目中的绝大部分配置都定义在 src/config.json 文件中。
你应该首先将 site.url 修改成自己的域名，避免导航错误。
以下是配置项的说明：
json
{
"site": {
"url": "", // 网站地址
"title": "", // 网站标题
"description": "", // 通用的网站描述 SEO
"keywords": "", // 通用的网站关键词 SEO
"lang": "zh-CN", // 网站的语言
"favicon": "", // 浏览器图标，存放在 public 目录下
"appleTouchIcon": "" // 苹果设备图标，存放在 public 目录下
},
"author": {
"name": "", // 作者名称
"twitterId": "", // 推特账号 ID，以 @ 开头，用于 Open Graph
"avatar": "" // 作者头像地址
},
// 首页 Hero 组件
"hero": {
"name": "", // 显示的名称
"bio": "", // 一句话介绍
"description": "", // 补充描述
// 社交账号
"socials": [
{
"name": "", // 社交平台类型
"icon": "", // 社交平台图标
"url": "", // 链接
"color": "" // 图标颜色
}
],
"yiyan": "" // 显示一言
},
"color": {
// 强调色，每次随机从中取出一组
"accent": [{ "light": "", "dark": "" }]
},
// 顶部导航栏
"menus": [
{
"name": "首页",
"link": "/",
"icon": "icon-pantone"
}
],
"posts": {
"perPage": 10 // 每一页显示的文章数量
},
"footer": {
"startTime": "" // 博客网站开始时间 请使用 ISO 格式
},
// doc search 搜索功能，请前往 https://docsearch.algolia.com/apply/ 申请
"docSearch": {
"appId": "",
"apiKey": "",
"indexName": ""
},
// waline 评论系统，前往 https://waline.js.org/ 查看
"waline": {
"serverURL": ""
},
// 赞助
"sponsor": {
"wechat": "" // 微信赞赏码图片地址
}
}
部署
这里只介绍了 Vercel，你当然可以选择其他平台例如：Cloudflare Pages 或你自己的服务器。
部署之前，确保你已经修改site.url。
部署到 Vercel
登录 Vercel 账号，点击右上角的 Add new... 选择 Project。然后在 Import Git Repository 中选择刚刚 Fork 的仓库，点击 Import 按钮。
进入项目配置页面，直接点击 Deploy 按钮，静静等待部署完成就 👌 了。
Vercel 会为你分配一个域名，你可以在项目设置中设置自定义域名，更多操作请参考 Vercel 文档。