108 lines
2.4 KiB
Markdown
108 lines
2.4 KiB
Markdown
# 恭学教育官网
|
||
|
||
基于 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 索引**的方式管理。
|
||
|
||
### 1. 创建文章文件
|
||
|
||
在 `docs/knowledge/` 目录下新建一个 `.md` 文件，文件名即为文章 ID，例如 `my-new-article.md`。
|
||
|
||
文件内容参考如下：
|
||
|
||
```markdown
|
||
---
|
||
id: my-new-article
|
||
title: 文章标题
|
||
summary: 文章摘要，会显示在知识库列表卡片上
|
||
category: exam_policy
|
||
tags:
|
||
- 天津专升本
|
||
- 考试政策
|
||
author: 恭学教育
|
||
publishedAt: 2026-06-15
|
||
coverImage: https://example.com/cover.png
|
||
viewCount: 0
|
||
isTop: false
|
||
---
|
||
|
||
<script setup>
|
||
import KnowledgeDetail from '../.vitepress/theme/pages/KnowledgeDetail.vue'
|
||
</script>
|
||
|
||
<KnowledgeDetail>
|
||
|
||
这里写正文内容，支持 HTML 和 Markdown。
|
||
|
||
</KnowledgeDetail>
|
||
```
|
||
|
||
`category` 常见取值：
|
||
|
||
- `exam_policy`：考试政策
|
||
- `school_intro`：院校介绍
|
||
- `study_method`：学习方法
|
||
- `exam_guide`：备考攻略
|
||
|
||
### 2. 更新列表索引
|
||
|
||
将文章元数据追加到 `docs/knowledge/index.json` 文件中：
|
||
|
||
```json
|
||
[
|
||
{
|
||
"id": "my-new-article",
|
||
"title": "文章标题",
|
||
"summary": "文章摘要，会显示在知识库列表卡片上",
|
||
"category": "exam_policy",
|
||
"tags": ["天津专升本", "考试政策"],
|
||
"coverImage": "https://example.com/cover.png",
|
||
"author": "恭学教育",
|
||
"publishedAt": "2026-06-15",
|
||
"viewCount": 0,
|
||
"isTop": false
|
||
}
|
||
]
|
||
```
|
||
|
||
### 文件作用说明
|
||
|
||
| 文件 | 作用 |
|
||
|------|------|
|
||
| `docs/knowledge/index.md` | 知识库列表页 |
|
||
| `docs/knowledge/index.json` | 知识库列表页读取的文章数据源 |
|
||
| `docs/knowledge/*.md` | 各篇文章详情页 |
|
||
|
||
## 本地开发
|
||
|
||
```bash
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
## 构建
|
||
|
||
```bash
|
||
npm run build
|
||
```
|