OSDN Git Service

update docs
authorXeonacid <h.dwwwwww@gmail.com>
Wed, 29 Aug 2018 14:38:32 +0000 (22:38 +0800)
committerXeonacid <h.dwwwwww@gmail.com>
Wed, 29 Aug 2018 14:48:44 +0000 (22:48 +0800)
.github/ISSUE_TEMPLATE/---bug.md
.github/pull_request_template.md
docs/intro/about.md
docs/intro/faq.md

index 2e942f8..b22cf30 100644 (file)
@@ -6,7 +6,7 @@ about: 指出出现的问题
 
 首先,十分欢迎你来给 OI WIki 开 issue,在提交之前,请花时间阅读一下这个模板的内容,谢谢合作!
 
-- [ ] 我已经读过了 [F.A.Q.](https://oi-wiki.org/intro/faq/)
+- [ ] 请确认已经读过了 [F.A.Q.](https://oi-wiki.org/intro/faq/)(确认过后请将选项打钩 / 填为 `[x]`)
 
 - 是出现了什么问题?(最好截图)
 
index 612bb0f..5139c56 100644 (file)
@@ -2,9 +2,9 @@
 
 - 请在 commit 的时候写比较有意义的 commit message
 - 请给 PR 起比较有意义的标题。
-- 请在 PR 之前检查一下您的 PR 是否存在以下常见问题:(确认后请将选项打钩 / 填为 `[x]`)
+- 请在 PR 之前检查一下您的 PR 是否存在以下常见问题:(确认无问题后请将选项打钩 / 填为 `[x]`)
    * [ ] 您的 MD 代码的书写格式,包括但不限于 **中文与英文之间、中文与阿拉伯数字、中文与 LaTeX 公式之间要有一个半角空格**,特别地,在中文全角符号与英文、阿拉伯数字、LaTeX 公式之间,**不需要**半角空格。(这个可以使用自动化工具辅助,比如 https://github.com/baurine/vscode-pangu)
-   * [ ] 对于 LaTeX 公式,请注意常见的问题,**一定要使用** `$\log$`、`$\min$`、`$\max$`、`$\gcd$` 等,而非 `$log$`、`$min$`、`$max$`、`$gcd$`。对于最小公倍数,请使用 `$\operatorname{lcm}$` 而非 `$lcm$`。
+   * [ ] 对于 LaTeX 公式,请注意常见的问题,**一定要使用** `$\log$`、`$\min$`、`$\max$`、`$\gcd$` 等,而非 `$log$`、`$min$`、`$max$`、`$gcd$`。对于最小公倍数,请使用 `$\operatorname{lcm}$` 而非 `$lcm$`,省略号请使用 `\cdots`,叉乘请使用 `\times`,点乘请使用 `\cdot`
    * [ ] 所有公式中的希腊字母等特殊符号,请不要使用输入法的插入特殊符号功能,而应该使用对应的 LaTeX 公式符号。如 `ϕ` 应该使用 `$\phi$` 或 `\varphi`。
    * [ ] 行间公式前后各要有一行空行。
    * [ ] 对于目录中存在公式的情况,请使用 HTML 代码而非直接插入公式以避免双倍公式的问题,请参考[避免 ToC 中双倍公式的写法](https://oi-wiki.org/intro/faq/#_13))。
index bdcfb6f..6209043 100644 (file)
@@ -6,7 +6,7 @@ A:不知道你在学 **OI** 的时候,面对庞大的知识体系,有没
 
 Q:我很感兴趣,怎么参与呢?
 
-A:**OI Wiki** 现在托管在 [Github](https://github.com/24OI/OI-wiki) 上,你可以直接访问这个 [repo](https://github.com/24OI/OI-wiki) 来查看最新进展。参与的途径包括在 [Github](https://github.com/24OI/OI-wiki) 上面开 Issue、Pull Request,或者在交流群中分享你的想法、直接向管理员投稿。目前,我们使用的框架是 [mkdocs](https://mkdocs.readthedocs.io),支持 Markdown 格式(当然也支持插入数学公式)。
+A:**OI Wiki** 现在托管在 [GitHub](https://github.com/24OI/OI-wiki) 上,你可以直接访问这个 [repo](https://github.com/24OI/OI-wiki) 来查看最新进展。参与的途径包括在 [GitHub](https://github.com/24OI/OI-wiki) 上面开 Issue、Pull Request,或者在交流群中分享你的想法、直接向管理员投稿。目前,我们使用的框架是 [mkdocs](https://mkdocs.readthedocs.io),支持 Markdown 格式(当然也支持插入数学公式)。
 
 Q:可是我比较弱…… 不知道我能做点什么?
 
@@ -18,7 +18,7 @@ A:现在主要是一些退役老年选手在做这件事,靠的都是信仰
 
 Q:听说过 nocow 吧,**OI Wiki** 怎么保证我们添加的内容不会像 nocow 那样突然间就不见了呢?
 
-A:我们把内容托管在 [Github](https://github.com/24OI/OI-wiki) 上面,即使我们的服务器翻车了,内容也不会丢失。另外,我们也会定期备份大家的心血,即使有一天 [Github](https://github.com/24OI/OI-wiki) 倒闭了(?),我们的内容也不会丢失。
+A:我们把内容托管在 [GitHub](https://github.com/24OI/OI-wiki) 上面,即使我们的服务器翻车了,内容也不会丢失。另外,我们也会定期备份大家的心血,即使有一天 [GitHub](https://github.com/24OI/OI-wiki) 倒闭了(?),我们的内容也不会丢失。
 
 Q:**OI Wiki** 好像现在大部分内容都是空的啊?
 
@@ -34,4 +34,4 @@ A:因为我们希望可以真正帮到更多的选手或者对这些内容感
 
 **OI Wiki** Team
 
-2018.8
\ No newline at end of file
+2018.8
index 05a60e5..6ab8f05 100644 (file)
@@ -12,24 +12,24 @@ Telegram 群组链接为 [@OIwiki](https://t.me/OIwiki) , QQ 群号码为 [`58
 
 **开个 [新 issue](https://github.com/24OI/OI-wiki/issues/new) 记录你要编写的内容。**
 
-### 我之前没怎么用过 Github
+### 我之前没怎么用过 GitHub
 
-参与 Wiki 的编写 ** 需要 ** 一个 Github 账号, ** 不需要 ** 高超的 Github 技巧。
+参与 Wiki 的编写 ** 需要 ** 一个 GitHub 账号, ** 不需要 ** 高超的 GitHub 技巧。
 
 举个栗子,假如我想要修改一个页面内容,应该怎么操作呢?
 
 1. 在 OI Wiki 网站上找到对应页面
 2. 点击 正文右上方、目录左侧的 **“编辑此页”** <svg class="octicon octicon-pencil" viewBox="0 0 14 16" version="1.1" width="14" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg> 按钮
-3. (应该已经跳转到了 Github 上的对应页面吧?)这时候右上方还会有一个 **“编辑此页”** <svg class="octicon octicon-pencil" viewBox="0 0 14 16" version="1.1" width="14" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg> 的按钮,点击它就可以在线编辑了
-4. 写好了之后点下方的绿色按钮(Propose file change),可能会提示没有权限。不必担心!Github 会自动帮你 fork 一份项目的文件并创建 Pull Request
+3. (应该已经跳转到了 GitHub 上的对应页面吧?)这时候右上方还会有一个 **“编辑此页”** <svg class="octicon octicon-pencil" viewBox="0 0 14 16" version="1.1" width="14" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg> 的按钮,点击它就可以在线编辑了
+4. 写好了之后点下方的绿色按钮(Propose file change),可能会提示没有权限。不必担心!GitHub 会自动帮你 fork 一份项目的文件并创建 Pull Request
 5. 之后点上方的绿色按钮(Create pull request)后,再点一下出现的绿色按钮(Create pull request)。
-6. æ\8f\90交ä¹\8bå\90\8eå°±å\8f¯ä»¥ç­\89å¾\85äº\86ï¼\8c管ç\90\86å\91\98ä¼\9aæ£\80æ\9f¥ä¸\80ä¸\8bï¼\8cå\90\88并æ\88\96è\80\85æ\8c\87å\87ºè¿\98è¦\81ä¿®æ\94¹ç\9a\84å\9c°æ\96¹ã\80\82å¦\82æ\9e\9cæ\9c\89æ¶\88æ\81¯ï¼\8cä¼\9aæ\9c\89é\82®ä»¶é\80\9aç\9f¥æ\88\96è\80\85ç½\91页ä¸\8aç\9a\84æ\8f\90é\86\92
+6. æ\8f\90交ä¹\8bå\90\8eå°±å\8f¯ä»¥ç­\89å¾\85ä»\96人å\90\88并æ\88\96è\80\85æ\8c\87å\87ºè¿\98è¦\81ä¿®æ\94¹ç\9a\84å\9c°æ\96¹ï¼\8cå½\93ç\84¶ä½ ä¹\9få\8f¯ä»¥ç»\99ä»\96人ç\9a\84 PR æ\8f\90å\87ºä¿®æ\94¹æ\84\8fè§\81ï¼\8cæ\88\96è\80\85å\8fªæ\98¯ç\82¹èµ\9e/踩ã\80\82å¦\82æ\9e\9cæ\9c\89æ¶\88æ\81¯ï¼\8cä¼\9aæ\9c\89é\82®ä»¶é\80\9aç\9f¥å\92\8c\88\96ç½\91页ä¸\8aç\9a\84æ\8f\90é\86\92ï¼\88å\8f\96å\86³äº\8eå\9c¨ä½ ä¸ªäºº Settings ä¸­ç\9a\84设置ï¼\89
 
 (有木有很简单?)
 
 如果还是不放心,可以参考这篇文章:https://juejin.im/entry/56e638591ea49300550885cc
 
-### 我之前用过 Github
+### 我之前用过 GitHub
 
 基本协作方式如下:
 
@@ -78,7 +78,7 @@ Telegram 群组链接为 [@OIwiki](https://t.me/OIwiki) , QQ 群号码为 [`58
 
 ### 如何修改一个 topic 的内容
 
-在对应页面右上方有一个编辑按钮 <svg class="octicon octicon-pencil" viewBox="0 0 14 16" version="1.1" width="14" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg> ,点击之后会跳转到 Github 上对应文件的位置。
+在对应页面右上方有一个编辑按钮 <svg class="octicon octicon-pencil" viewBox="0 0 14 16" version="1.1" width="14" height="16" aria-hidden="true"><path fill-rule="evenodd" d="M0 12v3h3l8-8-3-3-8 8zm3 2H1v-2h1v1h1v1zm10.3-9.3L12 6 9 3l1.3-1.3a.996.996 0 0 1 1.41 0l1.59 1.59c.39.39.39 1.02 0 1.41z"></path></svg> ,点击之后会跳转到 GitHub 上对应文件的位置。
 
 或者也可以自行阅读目录 [(mkdocs.yml)](https://github.com/24OI/OI-wiki/blob/master/mkdocs.yml#L17) 查找文件位置
 
@@ -91,16 +91,16 @@ Telegram 群组链接为 [@OIwiki](https://t.me/OIwiki) , QQ 群号码为 [`58
 
 我们推荐使用 [commitizen/cz-cli](https://github.com/commitizen/cz-cli) 来规范 commit message (并非强求)。
 
-### 我尝试访问 Github 的时候遇到了困难
+### 我尝试访问 GitHub 的时候遇到了困难
 
 推荐在 hosts 文件中加入如下几行:(来源: [@GoogleHosts](https://github.com/googlehosts/hosts/blob/master/hosts-files/hosts#L481-L485))
 
 ```
-## Github Start
+## GitHub Start
 192.30.253.118 gist.github.com
 192.30.253.112 github.com
 192.30.253.112 www.github.com
-## Github End
+## GitHub End
 ```
 
 可以在 [@GoogleHosts 主页](https://github.com/googlehosts/hosts) 上了解到更多信息。
@@ -111,7 +111,7 @@ Telegram 群组链接为 [@OIwiki](https://t.me/OIwiki) , QQ 群号码为 [`58
 
 或者:
 
-```
+```bash
 pip install -U -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
 ```
 
@@ -119,20 +119,20 @@ pip install -U -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
 
 如果有安装 `git bash`,可以加几个限制来减少下载量:
 
-```
+```bash
 git clone https://github.com/24OI/OI-wiki.git --depth=1 -b master
 ```
 
 参考这篇文章:https://blog.csdn.net/FreeApe/article/details/46845555
 
-### 我没装过 python3
+### 我没装过 Python 3
 
 可以访问 [Python 官网](https://www.python.org/downloads/) 了解更多信息。
 
 ### 好像提示我 pip 版本过低
 进入 cmd / shell 之后
 
-```
+```bash
 python -m pip install --upgrade pip
 ```
 
@@ -146,11 +146,11 @@ python -m pip install --upgrade pip
 
 ### 我 clone 了很久之前的 repo,怎么更新到新版本呢
 
-参考:      https://help.github.com/articles/syncing-a-fork/
+参考:https://help.github.com/articles/syncing-a-fork/
 
 ### 如果是装了之前的依赖怎么更新
 
-```
+```bash
 pip install -U -r requirements.txt
 ```
 
@@ -192,9 +192,9 @@ pagetime:
 
 注:默认的是开着的
 
-### Github 是不是不显示我的数学公式?
+### GitHub 是不是不显示我的数学公式?
 
-是的,Github 的预览不显示数学公式。但是请放心,mkdocs 是支持数学公式的,可以正常使用,只要是 mathjax 支持的句式都可以使用。
+是的,GitHub 的预览不显示数学公式。但是请放心,mkdocs 是支持数学公式的,可以正常使用,只要是 mathjax 支持的句式都可以使用。
 
 ### 我的公式为什么在目录里没有正常显示?好像双倍了?