文档编写指南

EmptyDust2025/8/1大约 3 分钟约 931 字

文档编写指南

欢迎为 InSUEP 项目贡献文档！本指南将帮助您了解如何编写符合项目规范的文档。

更多详细内容请参考 https://theme-hope.vuejs.press/zh/guide/markdown/

文档结构

每个 Markdown 文档都应该包含以下 frontmatter 信息：

---
title: 文档标题
author:
  - name: 作者姓名
    url: 作者网站
    email: 作者邮箱
date: 2025-01-01
---

Frontmatter 字段说明

必需字段

title: 文档标题，将显示在页面顶部

可选字段

author: 作者信息
- 可以是简单字符串：author: 作者姓名
- 可以是对象：包含 name、url、email
- 可以是数组：多个作者
date: 写作日期，格式为 yyyy-mm-dd
category: 文档分类
tag: 文档标签，可以是数组
pageInfo: 控制页面信息显示
- 默认显示：作者、访问量、写作日期、分类、标签、预计阅读时间
- 可自定义显示顺序和内容

页面信息功能

支持的页面信息条目

条目	说明	数据来源
Author	作者信息	frontmatter 中的 author 字段
Date	写作日期	frontmatter 中的 date 字段
Original	是否原创	frontmatter 中的 isOriginal 字段
Category	分类	frontmatter 中的 category 字段
Tag	标签	frontmatter 中的 tag 字段
ReadingTime	预计阅读时间	自动计算（默认 300 字/分钟）
Word	字数统计	自动计算
PageView	访问量	需要配置 Waline 评论系统

作者信息配置示例

单个作者（简单形式）：

author: 张三

单个作者（详细形式）：

author:
  name: 张三
  url: https://github.com/zhangsan
  email: zhangsan@example.com

多个作者：

author:
  - name: 张三
    url: https://github.com/zhangsan
  - name: 李四
    email: lisi@example.com

写作规范

1. 标题规范

使用清晰的标题
标题应该简洁明了，能够概括文档内容

2. 日期格式

使用标准格式：yyyy-mm-dd
例如：2025-01-01

3. 分类和标签

分类应该反映文档的主要主题
标签可以更具体地描述文档内容
建议使用中文标签，便于理解

4. 内容编写

使用清晰的段落结构
适当使用列表和表格
添加必要的图片和链接
保持内容的准确性和时效性

示例文档

---
title: 宿舍指南
author:
  name: 学长学姐
  url: https://github.com/InSUEP
date: 2025-01-01
category: 新生指南
tag:
  - 宿舍
  - 生活指南
  - 新生必读
pageInfo: ["Author", "Date", "Category", "Tag", "ReadingTime"]
---

# 宿舍指南

这里是宿舍指南的内容...

## 宿舍类型

- 四人间
- 六人间
- 八人间

## 注意事项

1. 遵守宿舍规定
2. 保持卫生整洁
3. 注意用电安全