docs: typo and other small fixes

- typo - inconsistent TOC - Github → GitHub, bithesis → BIThesis, $LaTeX$ → $\LaTeX$ - redundant/missing spaces - [Note](community/community#16925) - link
BITNP · Jan 17, 2023 · 26400cb · 26400cb
1 parent 589e0b4
commit 26400cb
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 42 deletions.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -2,7 +2,7 @@
 
 ## 任务管理
 
-本项目采用 [Github Projects](https://github.com/BITNP/BIThesis/projects) 进行任务管理。
+本项目采用 [GitHub Projects](https://github.com/BITNP/BIThesis/projects) 进行任务管理。
 你可以每次选择其中的一个小的 TODO 进行开发；来帮助项目一点一点前进。
 
 ## 开发命令
@@ -37,7 +37,7 @@ make doc
 3. 然后运行 `make copy` 将新的 `*.cls` 更新到 `templates/` 下。
 4. 不要忘记更新 `bithesis.dtx` 中的手册部分，添加相应说明。
 5. 运行 `make doc` 编译手册。
-6. 运行测试，确保你的改动不会影响到其他效果。
+6. 运行测试，确保你的改动不会影响到其他功能。
 
 #### 修改 `templates/` 中模板的行为
 
@@ -51,7 +51,7 @@ make doc
 由于我们常常需要实时预览代码编译的效果，而 LaTeX 本身没有提供实时编译的功能。
 因此我们常常需要来回运行 `make copy`、`latexmk` 以达成实时编译的效果。
 
-因此 Makefiles 里面提供了一些辅助开发的命令（以 `dev-`）开头。
+因此 Makefile 里面提供了一些辅助开发的命令（以 `dev-`）开头。
 可以帮助你自动化以上流程。
 
 或者你可以使用类似 `rg --files | entr make copy` 以及 `rg --files | entr latexmk` 来达到
@@ -60,18 +60,18 @@ make doc
 ## 参考资料
 
 - 本项目 LaTeX3，因此可以参考的手册包括 expl3 的文档。
-- fduthesis 项目代码有很多最佳实践，可以参考。
+- [fduthesis 项目代码](https://github.com/stone-zeng/fduthesis)有很多最佳实践，可以参考。
 - 样式部分，应该参考研究生院和教务部的相关文件和通知。
 
 ## 单元测试和回归测试
 
-运行 `make test` 将对所有的模板进行编译测试（同样被用于 Github Action）。
+运行 `make test` 将对所有的模板进行编译测试（同样被用于 GitHub Actions）。
 
 运行 `make regression-test` 进行回归测试，该命令将比较目前已发布的最新版本和本地版本生成的 PDF 的差异。
 使用前请确保 `diff-pdf`、`zsh` 已经安装。
 
 运行 `make check-cls` 确保 `bithesis.dtx` 的修改都被同步到了 `templates/` 中。
-（同样被用于 Github Action）
+（同样被用于 GitHub Actions）
 
 ## 打包
 

diff --git a/README-bithesis.md b/README-bithesis.md
@@ -11,7 +11,7 @@ The current maintainer of this project is [Feng Kaiyu](https://github.com/fky201
 [![License](https://badgen.net/github/license/BITNP/BIThesis?color=008080&labelColor=2b2b2b)](./LICENSE)
 
 BIThesis is an unofficial LaTeX template set for your 
-**undergraduate, master or doctoral thesis** as well as other academic writing here at BIT.
+**undergraduate, master, or doctoral thesis** as well as other academic writing here at BIT.
 
 This project is supported by the _[Dept. of Undergraduate Academic Affairs, BIT](https://jwc.bit.edu.cn/)_ and the _[School of Computer Science and Technology, BIT](https://cs.bit.edu.cn/)_. See [Acknowledgements - Official Sponsors](https://bithesis.bitnp.net/guide/acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors).
 
@@ -21,15 +21,15 @@ At present, `bithesis` only supports XeTeX and LuaTeX engines. `bithesis` only a
 
 ### Installation
 
-```
+```shell
 tlmgr install bithesis
 ```
 
 Or make a clone from our [repo](https://github.com/BITNP/BIThesis). Then run: `make cls` to generate class files.
 
 ## How Do I Use BIThesis?
 
-**For a comprehensive guide on how to install LaTeX, compile `bithesis`, and use a single one of BIThesis' template, please refer to BIThesis' Wiki. 👇**
+**For a comprehensive guide on how to install LaTeX, compile `bithesis`, and use BIThesis' templates, please refer to BIThesis' Wiki. 👇**
 
 [![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)](https://bithesis.bitnp.net/)
 
@@ -39,5 +39,5 @@ For more details, please see the [contributing doc](./contributing.md).
 
 ## Contributors
 
-For more information, please see: [Github Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) and [Acknowledgements](https://bithesis.bitnp.net/guide/acknowledgements.html).
+For more information, please see: [GitHub Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) and [Acknowledgements](https://bithesis.bitnp.net/guide/acknowledgements.html).
 
diff --git a/README.md b/README.md
@@ -10,30 +10,30 @@
 [![Latexmk](https://badgen.net/badge/compiler/latexmk/blue)](https://mg.readthedocs.io/latexmk.html)
 [![License](https://badgen.net/github/license/BITNP/BIThesis?color=008080&labelColor=2b2b2b)](./LICENSE)
 [![Join on QQ Chat Group](https://img.shields.io/badge/QQ%E7%BE%A4-737548118-green)](https://jq.qq.com/?_wv=1027&k=KYDrmS5z)
-[![Github Checks](https://badgen.net/github/checks/BITNP/BIThesis)](https://github.com/BITNP/BIThesis/actions)
+[![GitHub Checks](https://badgen.net/github/checks/BITNP/BIThesis)](https://github.com/BITNP/BIThesis/actions)
 [![CTAN Version](https://badgen.net/ctan/v/bithesis)](https://www.ctan.org/pkg/bithesis)
 
-**有关如何安装 $LaTeX$、编译 BIThesis 模板的全面指南，请参阅 BIThesis 的 Wiki。👇**
+**有关如何安装 $\LaTeX$、编译 BIThesis 模板的全面指南，请参阅 BIThesis 的 Wiki。👇**
 
 [![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)][wiki]
 
 **有关 BIThesis 提供的配置选项和命令，请参阅 BIThesis 的模板使用手册。👇**
 
-[![bithesis Documentation](https://img.shields.io/badge/bithesis-Documentation-008080?logo=LaTeX&labelColor=2b2b2b&style=for-the-badge)](http://mirrors.ctan.org/macros/unicodetex/latex/bithesis/bithesis.pdf)
+[![BIThesis Documentation](https://img.shields.io/badge/bithesis-Documentation-008080?logo=LaTeX&labelColor=2b2b2b&style=for-the-badge)](http://mirrors.ctan.org/macros/unicodetex/latex/bithesis/bithesis.pdf)
 
-_（此文档已被包含在 [ Releases ][releases] 的文件中）_
+_（此文档已被包含在 [Releases][releases] 的文件中）_
 
 </div>
 
 <div align="center">
 
-:raised_hand: **BIThesis 正在招募项目维护者！** :raised_hand: 如果你对 $LaTeX$ 有使用经验、有兴趣进一步学习、有 Git 使用经验、并且希望帮助这个项目变得更好的话。欢迎与 [Feng Kaiyu](https://github.com/fky2015) 取得联系，加入我们。
+:raised_hand: **BIThesis 正在招募项目维护者！** :raised_hand: 如果你对 $\LaTeX$ 有使用经验、有兴趣进一步学习、有 Git 使用经验、并且希望帮助这个项目变得更好的话。欢迎与 [Feng Kaiyu](https://github.com/fky2015) 取得联系，加入我们。
 
 </div>
 
 <h2>欢迎</h2>
 
-BIThesis 是针对北京理工大学本科生毕业毕业论文、研究生学位论文的一个非官方的 $LaTeX$ 模板，BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 $LaTeX$ 模板。
+BIThesis 是针对北京理工大学本科生毕业设计论文、研究生学位论文的一个非官方的 $\LaTeX$ 模板，BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 $\LaTeX$ 模板。
 
 > 本项目获得了 [北京理工大学教务部](http://jwc.bit.edu.cn/)、[北京理工大学计算机学院](http://cs.bit.edu.cn/) 的认可、背书与大力支持。详见：[致谢 - 官方赞助](https://bithesis.bitnp.net/guide/acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)。
 
@@ -72,10 +72,12 @@ _订阅更新，询问问题，提出需求……请加入北理 BIThesis 官方
 <h2>内容</h2>
 
 - [项目内容](#项目内容)
+- [使用方法](#使用方法)
 - [开发者指南](#开发者指南)
+- [参考规范](#参考规范)
 - [贡献者指南](#贡献者指南)
 - [贡献者](#贡献者)
-- [相关项目](#相关项目)
+- [特别感谢](#特别感谢)
 - [发布状态](#发布状态)
 
 ## 项目内容
@@ -84,7 +86,7 @@ _订阅更新，询问问题，提出需求……请加入北理 BIThesis 官方
 
 ## 使用方法
 
-1. 安装或升级最新的 LaTeX 套装，详见[wiki](https://bithesis.bitnp.net/guide/getting-started.html)。
+1. 安装或升级最新的 LaTeX 套装，详见 [wiki](https://bithesis.bitnp.net/guide/getting-started.html)。
 2. 根据需要，下载[最新的 Releases](https://github.com/BITNP/BIThesis/releases/latest)。
 3. 开始撰写。
 
@@ -94,7 +96,7 @@ _订阅更新，询问问题，提出需求……请加入北理 BIThesis 官方
 
 **以下内容供开发者使用，如果你是普通用户的话，请参考我们的[在线文档][wiki] 。**
 
-详见[开发者指南](./DEVELOPMENT.md)
+详见[开发者指南](./DEVELOPMENT.md)。
 
 ## 参考规范
 
@@ -112,11 +114,11 @@ _订阅更新，询问问题，提出需求……请加入北理 BIThesis 官方
 
 ## 贡献者
 
-参见 [Github Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) 与 [BIThesis - 致谢](https://bithesis.bitnp.net/guide/acknowledgements.html)。
+参见 [GitHub Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) 与 [BIThesis - 致谢](https://bithesis.bitnp.net/guide/acknowledgements.html)。
 
 ## 特别感谢
 
-- [ biblatex-gb7714-2015 ](https://github.com/hushidong/biblatex-gb7714-2015)：提供了易用的国标引用格式和细心指导。
+- [biblatex-gb7714-2015 ](https://github.com/hushidong/biblatex-gb7714-2015)：提供了易用的国标引用格式和细心指导。
 - [北京理工大学硕士（博士）学位论文 LaTeX 模板](https://github.com/BIT-thesis/LaTeX-template)：提供了研究生论文样式的代码参考。
 - [fduthesis（复旦大学论文模板）](https://github.com/stone-zeng/fduthesis)：提供了包编写的最佳实践。
 - [ThuThesis（清华大学论文模板）](https://github.com/tuna/thuthesis)：提供了 dtx 样式的参考。

diff --git a/contributing-zh.md b/contributing-zh.md
@@ -12,27 +12,28 @@
 
 ## Guidance
 
-**[我不想看下面的内容，我只是想问个小问题!!!](#加入我们的-QQ-群)**
+**[我不想看下面的内容，我只是想问个小问题！！！](#加入我们的-QQ-群)**
 
 |                | 普通使用者                      | 开发者                                          |
 | ----------     | ------------------------------- | -------------------------------------------     |
 | 提出问题       | [QQ 群](#加入我们的-qq-群) | [QQ 群](#加入我们的-qq-群)                 |
-| 提交 Bug       | [QQ 群](#加入我们的-qq-群) | [Github - Issues](#在-github-上提交-bug)        |
-| 有好的想法     | [QQ 群](#加入我们的-qq-群) | Github - Issues                 |
-| 提交 PR        |                                 | [Github - Pull Request](#提交-pull-request)     |
+| 提交 Bug       | [QQ 群](#加入我们的-qq-群) | [GitHub - Issues](#在-github-上提交-bug)       |
+| 有好的想法     | [QQ 群](#加入我们的-qq-群) | GitHub - Issues                |
+| 提交 PR        |                                 | [GitHub - Pull Request](#提交-pull-request)    |
 | 有信心维护代码 |                                 | [加入QQ 群并联系我们](#加入我们的-qq-群) |
 
 ## 加入我们的 QQ 群
 
-在我们提供的[QQ 群(737548118)][QQ chat group invitation]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。
+在我们提供的 [QQ 群`737548118`][QQ chat group invitation]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。
 
 [![Join on QQ Chat Group](https://img.shields.io/badge/QQ%E7%BE%A4-737548118-green)](https://jq.qq.com/?_wv=1027&k=KYDrmS5z)
 
-> 提示：关于具体如何提出问题并没有明确的要求。总之请提供尽可能详细的信息，并且思考一下这个问题是不是已经被解决了。
+> **Note**
+> 关于具体如何提出问题并没有明确的要求。总之请提供尽可能详细的信息，并且思考一下这个问题是不是已经被解决了。
 
-## 在 Github 上提交 Bug
+## 在 GitHub 上提交 Bug
 
-如果你能更精确的定位问题所在，或者能够提供更详细的信息；你可以向我们[提交一个 issue][issue reporting link]。
+如果你能更精确地定位问题所在，或者能够提供更详细的信息；你可以向我们[提交一个 issue][issue reporting link]。
 
 ## 提交 Pull Request
 
@@ -48,7 +49,7 @@
 6. 在 PR 被合并之前请保持关注，以便进行修改。
 
 更细致的流程请参考
-_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_。
+_[GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_。
 
 [QQ chat group invitation]: https://jq.qq.com/?_wv=1027&k=KYDrmS5z
 [issue reporting link]: https://github.com/BITNP/BIThesis/issues/new
diff --git a/contributing.md b/contributing.md
@@ -13,32 +13,33 @@ and feel free to propose changes to this document in a pull request.
 
 **[I don't want to read this whole thing, I just have a small question!!!](#join-our-QQ-chat-group)**
 
-|                 | For Users                        | For Developers                                 |
-| --------------- | -------------------------------- | ---------------------------------------------- |
-| Have a Question | [QQ Chat Group](#join-our-QQ-chat-group) | [QQ Chat Group](#join-our-QQ-chat-group)               |
-| Bug Report      | [QQ Chat Group](#join-our-QQ-chat-group) | [Github - Issues](#bug-report-on-github)       |
-| Feature Request | [QQ Chat Group](#join-our-QQ-chat-group) | [QQ Chat Group](#join-our-QQ-chat-group)               |
-| Pull Request    |                                  | [Github - Pull Request](#pull-request-process) |
+|                 | For Users                                | For Developers                                 |
+| --------------- | ---------------------------------------- | ---------------------------------------------- |
+| Have a Question | [QQ Chat Group](#join-our-QQ-chat-group) | [QQ Chat Group](#join-our-QQ-chat-group)       |
+| Bug Report      | [QQ Chat Group](#join-our-QQ-chat-group) | [GitHub - Issues](#bug-report-on-github)       |
+| Feature Request | [QQ Chat Group](#join-our-QQ-chat-group) | [QQ Chat Group](#join-our-QQ-chat-group)       |
+| Pull Request    |                                          | [GitHub - Pull Request](#pull-request-process) |
 
 ## Join Our QQ Chat Group
 
-We provide an [QQ Chat Group][QQ chat group invitation]
+We provide a [QQ Chat Group][QQ chat group invitation]
 with **a bunch of active maintainers** and **a friendly community**
 to give helpful advice **if you have any questions**.
 
 [![Join on QQ Chat Group](https://img.shields.io/badge/QQ%E7%BE%A4-737548118-green)](https://jq.qq.com/?_wv=1027&k=KYDrmS5z)
 
-> note: there is no detailed rules about how to ask question, just provide enough information and
-rethink before write.
+> **Note**
+> There are no detailed rules about how to ask question, just provide enough information and
+> rethink before write.
 
-## Bug Report on Github
+## Bug Report on GitHub
 
 If you can locate the bug or provide more detailed information, you may
 _[report an issue here][issue reporting link]_.
 
 ## Pull Request Process
 
-Pull Request are welcomed!
+Pull Requests are welcomed!
 
 The following steps will help you finish a pull request.
 
@@ -50,7 +51,7 @@ The following steps will help you finish a pull request.
 6. Keep in touch with further discussion and refine.
 
 For more information, refer to the
-_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.
+_[GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.
 
 [QQ chat group invitation]: https://jq.qq.com/?_wv=1027&k=KYDrmS5z
 [issue reporting link]: https://github.com/BITNP/BIThesis/issues/new