Skip to content

Commit 8c105df

Browse files
committed
docs(readme.md readme-zh.md): added some reminders
1 parent de4f3a8 commit 8c105df

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README-zh.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,21 @@
1818
mkdocs serve
1919
```
2020

21-
进行测试。
21+
进行本地服务器测试,或者使用
22+
23+
```bash
24+
mkdocs build
25+
```
26+
27+
检查生成的静态页面。
2228

2329
本仓库采用 [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) 的方案自动进行 `commit message` 的审查,请确保 `commit message` 符合 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范。但也不必过多担心,本仓库已集成 [Commitizen](https://github.com/commitizen/cz-cli) 协助填写 `commit message` 。具体包及版本见 [package.json](package.json) ,在首次 `commit` 前请使用
2430

2531
```bash
2632
npm install
2733
```
2834

29-
安装所有依赖。
35+
安装所有依赖,安装成功后可使用 `git cz` 替代 `git commit`
3036

3137
若进行修改的是页面,请尽量确保文档遵守 [Markdown Rules](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md)[Markdown 简体中文与西文混排要点](https://github.com/selfteaching/markdown-writing-with-mixed-cn-en),并且不要忘记修改 [mkdocs.yml](mkdocs.yml)`nav` 部分。
3238

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,21 @@ If you have any content you want to add, correct, or delete on this site, you ar
1818
mkdocs serve
1919
```
2020

21-
to test it first.
21+
to test it on local server, or use
22+
23+
```bash
24+
mkdocs build
25+
```
26+
27+
to check the generated static pages.
2228

2329
This repository uses the [commitlint](https://github.com/conventional-changelog/commitlint) + [husky](https://github.com/typicode/husky) solution to automatically review `commit messages`. Please ensure that your `commit messages` conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. However, don't worry too much, as this repository has integrated [Commitizen](https://github.com/commitizen/cz-cli) to assist in writing `commit messages`. For specific packages and versions, see [package.json](package.json). Before first committing, please use
2430

2531
```bash
2632
npm install
2733
```
2834

29-
to install all dependencies.
35+
to install all dependencies. After successful installation, you can use `git cz` instead of `git commit`.
3036

3137
If you are modifying a page, please ensure that the document complies with [Markdown Rules](https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md) and [Markdown Writing with Mixed Chinese and English](https://github.com/selfteaching/markdown-writing-with-mixed-cn-en). Also, don't forget to update the `nav` section of [mkdocs.yml](mkdocs.yml).
3238

0 commit comments

Comments
 (0)