chore: 简化 build 脚本并补充 README 域名配置说明
This commit is contained in:
18
README.md
18
README.md
@@ -2,6 +2,24 @@
|
|||||||
|
|
||||||
基于 VitePress 构建的恭学教育官方网站。
|
基于 VitePress 构建的恭学教育官方网站。
|
||||||
|
|
||||||
|
## 修改站点域名
|
||||||
|
|
||||||
|
项目构建时通过 `SITE_URL` 环境变量指定站点域名,该域名会用于生成 `sitemap.xml`、`<link rel="canonical">` 以及 Open Graph 等 SEO 标签。
|
||||||
|
|
||||||
|
当前 `package.json` 中的 `build` 脚本已默认设置为:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
SITE_URL=https://gongxue100.com vitepress build docs
|
||||||
|
```
|
||||||
|
|
||||||
|
如需切换到其他域名(例如测试环境或新域名),直接修改 `package.json` 中 `scripts.build` 的 `SITE_URL` 值即可:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
SITE_URL=https://你的域名.com vitepress build docs
|
||||||
|
```
|
||||||
|
|
||||||
|
> 注意:修改域名后需重新执行 `npm run build` 才能使 sitemap 和 SEO 标签生效。
|
||||||
|
|
||||||
## 如何添加知识库文章
|
## 如何添加知识库文章
|
||||||
|
|
||||||
项目中的知识库文章位于 `docs/knowledge/` 目录,采用**静态 Markdown + JSON 索引**的方式管理。
|
项目中的知识库文章位于 `docs/knowledge/` 目录,采用**静态 Markdown + JSON 索引**的方式管理。
|
||||||
|
|||||||
@@ -4,9 +4,7 @@
|
|||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vitepress dev docs --host 0.0.0.0",
|
"dev": "vitepress dev docs --host 0.0.0.0",
|
||||||
"build": "vitepress build docs",
|
"build": "SITE_URL=https://gongxue100.com vitepress build docs",
|
||||||
"build:test": "SITE_URL=https://seotest.gongxue100.com vitepress build docs",
|
|
||||||
"build:prod": "SITE_URL=https://www.gongxue100.com vitepress build docs",
|
|
||||||
"serve": "vitepress serve docs"
|
"serve": "vitepress serve docs"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|||||||
Reference in New Issue
Block a user