feat(WIKI): wiki 2025 BREAKING CHANGE: Older content is categorized into older folders

This commit is contained in:
camera-2018
2024-07-28 23:50:26 +08:00
parent 30d546dbd7
commit 4ff7c80ebf
798 changed files with 558 additions and 294 deletions

View File

@@ -28,7 +28,7 @@
## 文档风格
1. 使用 Markdown 编写文档,文档格式参考 Markdown 语法。
2. 一个页面只有一个1级标题H1一个#其他标题从2级开始H2##)。
2. 一个页面必须且只有一个1级标题H1一个#其他标题从2级开始H2##)。
3. 本项目自动在英文与中文、数字与中文之间添加空格。
```markdown
@@ -216,11 +216,11 @@ export type Lang =
:::
::: tip 🤓 注意
尽量不要使用 `typora` 因为它的渲染效果和本项目前端框架 `vitepress` 不一致。
尽量不要使用 `typora` 等编辑器编辑完 .md文件后直接提交因为它的渲染效果和本项目前端 md 渲染器 `vitepress markdown-it` 不一致。
在 `typora` 中编辑完成后,确认一下 .md 文件源代码是否为正常 Markdown 。
编辑完成后需要启动本项目在前端查看效果。
编辑完成后请务必启动本项目在前端查看效果。
:::
## 项目构建指南
@@ -247,12 +247,16 @@ npm run docs:preview #预览线上环境
![](static/xxx.png)
```
注意尽量不要使用 `img` 标签,因为经前端构建解析后路径会不正确。
注意尽量不要使用 `img` 这个 HTML 标签,因为经前端构建解析后路径会不正确。
后续会统一放置到 cos 存储桶中。
## 项目配置指南
::: warning 🚧 注意
如果改了文件路径却没有配置 `.vitepress/config.js`、`.vitepress/sidebar.js` 文件会导致项目构建失败。
:::
修改新添加或移动位置的 md 文件需要在 `.vitepress/config.js`、`.vitepress/sidebar.js` 中添加或修改对应的配置。
> sidebar.js 文件会管理显示在左侧导航栏的所有路由
@@ -261,7 +265,7 @@ npm run docs:preview #预览线上环境
## 如何使用 Git 和 Github
详见 [3.5 Git和Github](./3.编程思维体系构建/3.5git与github.md)
详见 [3.5 Git和Github](./2023旧版内容/3.编程思维体系构建/3.5git与github.md)
## Commit Message 规范
@@ -306,6 +310,10 @@ subject为commit概述
其中详细内容可以参照 [约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0/)
本项目额外有使用 semantic-release 自动化版本发布,所以请务必遵循规范提交。
注意fix、feat、BREAKING CHANGE 这三种类型的提交会触发自动版本发布。
![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)
## Pull Request 流程与指南