README.md

   1 [![Word Art](docs/images/wordArt.webp)](https://oi-wiki.org/)
   2
   3 # 欢迎来到 **OI Wiki**！
   4
   5 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-brightgreen?logo=gitpod&style=flat-square)](https://gitpod.io/#https://github.com/OI-wiki/OI-wiki)
   6 [![GitHub Actions](https://img.shields.io/github/workflow/status/OI-Wiki/OI-Wiki/Build?style=flat-square)](https://github.com/OI-wiki/OI-wiki/actions?query=workflow%3ABuild)
   7 [![Uptime Robot Status](https://img.shields.io/uptimerobot/status/m781254113-3e3bac467c64fc99eafd383e.svg?style=flat-square)](https://status.oi-wiki.org/)
   8 [![Telegram](https://img.shields.io/badge/Telegram-OI%20Wiki-%232CA5E0?style=flat-square&logo=telegram)](https://t.me/OIwiki)
   9 [![QQ](https://img.shields.io/badge/QQ%20group-OI%20Wiki-blue?style=flat-square&logo=tencent-qq)](https://jq.qq.com/?_wv=1027&k=5EfkM6K)
  10 [![GitHub watchers](https://img.shields.io/github/watchers/OI-Wiki/OI-Wiki.svg?style=social&label=Watch)](https://github.com/OI-wiki/OI-wiki)
  11 [![GitHub stars](https://img.shields.io/github/stars/OI-Wiki/OI-Wiki.svg?style=social&label=Stars)](https://github.com/OI-wiki/OI-wiki)
  12
  13 * * *
  14
  15 ## 内容
  16
  17 编程竞赛发展多年，难度越来越高，内容越来越复杂，而网上资料大多零散，初学者往往并不知道如何系统地学习相关知识，需要花费大量时间摸索。
  18
  19 为了方便热爱编程竞赛的小伙伴更好地入门，2018 年 7 月份，**OI Wiki** 迁移至 GitHub。随着 **OI Wiki** 的内容不断完善，越来越多的小伙伴参与其中。
  20
  21 **OI Wiki** 致力于成为一个免费开放且持续更新的知识整合站点，大家可以在这里获取关于 **编程竞赛 (competitive programming)** 有趣又实用的知识，我们为大家准备了竞赛中的基础知识、常见题型、解题思路以及常用工具等内容，帮助大家更快速深入地学习编程竞赛。
  22
  23 目前，**OI Wiki** 的内容还有很多不完善的地方，知识点覆盖不够全面，存在一些低质量页面需要修改。**OI Wiki** 团队以及参与贡献的小伙伴们正在积极完善这些内容。
  24
  25 关于上述待完善内容，请参见 **OI Wiki** 的 [Issues](https://github.com/OI-wiki/OI-wiki/issues) 以及 [迭代计划](https://github.com/OI-wiki/OI-wiki/labels/Iteration%20Plan%20%2F%20%E8%BF%AD%E4%BB%A3%E8%AE%A1%E5%88%92)。
  26
  27 与此同时， **OI Wiki** 源于社区，提倡 **知识自由**，在未来也绝不会商业化，将始终保持独立自由的性质。
  28
  29 * * *
  30
  31 ## 部署
  32
  33 本项目目前采用 [MkDocs](https://github.com/mkdocs/mkdocs) 部署在 [oi-wiki.org](https://oi-wiki.org)。
  34
  35 我们在 [status.oi-wiki.org](https://status.oi-wiki.org) 维护了一份镜像站列表，它们的内容和 [oi-wiki.org](https://oi-wiki.org) 都是相同的。
  36
  37 当然，也可以在本地部署。（**需要 Python 3**）
  38
  39 [点击查看用 asciinema 录制的流程](https://asciinema.org/a/220681)
  40
  41 **如果遇到问题，可以查阅 [F.A.Q.](https://oi-wiki.org/intro/faq/) 来了解更多信息。**
  42
  43 ```bash
  44 git clone https://github.com/OI-wiki/OI-wiki.git --depth=1
  45
  46 cd OI-wiki
  47
  48 # 安装 mkdocs
  49 pip3 install -U -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
  50
  51 # 使用我们的自定义主题
  52 chmod +x ./scripts/install_theme.sh && ./scripts/install_theme.sh
  53
  54 # 两种方法（选其一即可）：
  55 # 1. 运行一个本地服务器，访问 http://127.0.0.1:8000 可以查看效果
  56 mkdocs serve -v
  57
  58 # 2. 在 site 文件夹下得到静态页面
  59 mkdocs build -v
  60
  61 # 获取 mkdocs 的命令行工具的说明（解释了命令和参数的含义）
  62 mkdocs --help
  63 ```
  64
  65 我们现在在服务器端渲染 MathJax ，如果希望实现类似效果，可以参考 [.travis.yml](https://github.com/OI-wiki/OI-wiki/blob/master/.travis.yml)。（需要安装 Node.js）
  66
  67 ### 镜像
  68
  69 ```bash
  70 # Gitee 码云 上的镜像仓库和 GitHub 仓库的内容相同
  71 git clone https://gitee.com/OI-wiki/OI-wiki.git
  72 ```
  73
  74 ### 离线版
  75
  76 可以使用 `gh-pages` 分支的内容
  77
  78 ```bash
  79 git clone https://gitee.com/OI-wiki/OI-wiki.git -b gh-pages
  80 ```
  81
  82 本地启动一个 http 服务器可能会更方便一些。
  83
  84 ```bash
  85 # 如果是 python3
  86 python3 -m http.server
  87 # 如果是 python2
  88 python2 -m SimpleHTTPServer
  89 # 有些环境下找不到名叫 python3/python2 的可执行文件，不妨运行 python 试试
  90 ```
  91
  92 ### Docker
  93
  94 详见 [Docker 部署](https://oi-wiki.org/intro/docker-deploy/)
  95
  96 * * *
  97
  98 ## 如何参与完善 OI Wiki
  99
 100 我们非常欢迎你为 **OI Wiki** 编写内容，将自己的所学所得与大家分享。
 101
 102 具体的贡献方式在 [如何参与](https://oi-wiki.org/intro/htc/)。
 103
 104 * * *
 105
 106 ## 版权声明
 107
 108 <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/"><img alt="知识共享许可协议" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />
 109 除特别注明外，项目中除了代码部分均采用<a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/deed.zh"> (Creative Commons BY-SA 4.0) 知识共享署名 - 相同方式共享 4.0 国际许可协议</a> 及附加的 [The Star And Thank Author License](https://github.com/zTrix/sata-license) 进行许可。
 110
 111 换言之，使用过程中您可以自由地共享、演绎，但是必须署名、以相同方式共享、分享时没有附加限制，
 112
 113 而且需要为 GitHub 仓库点赞（Star）。
 114
 115 而如果你想要引用这个 GitHub 仓库，可以使用如下的 bibtex：
 116
 117 ```
 118 @misc{oiwiki,
 119   author = {OI Wiki Team},
 120   title = {OI Wiki},
 121   year = {2016},
 122   publisher = {GitHub},
 123   journal = {GitHub Repository},
 124   howpublished = {\url{https://github.com/OI-wiki/OI-wiki}},
 125 }
 126 ```
 127
 128 * * *
 129
 130 ## 鸣谢
 131
 132 本项目受 [CTF Wiki](https://ctf-wiki.org/) 的启发，在编写过程中参考了诸多资料，在此一并致谢。
 133
 134 非常感谢一起完善 **OI Wiki** 的 [小伙伴们](https://github.com/OI-wiki/OI-wiki/graphs/contributors) 和为 **OI Wiki** 捐赠的 [朋友们](https://oi-wiki.org/intro/thanks/) ！！
 135
 136 <a href="https://github.com/OI-wiki/OI-wiki/graphs/contributors"><img src="https://opencollective.com/oi-wiki/contributors.svg?width=890&button=false" /></a>
 137
 138 特别感谢 [24OI](https://github.com/24OI) 的朋友们的大力支持！
 139
 140 <!-- <img src='https://i.loli.net/2018/12/07/5c0a6e4c31b30.png' alt='QVQNetWork' width=233>
 141 鸣谢 QVQNetwork 赞助的服务器。 -->
 142
 143 感谢 北大算协 和 Hulu 的支持！
 144
 145 ![](https://assets.pcmag.com/media/images/560767-hulu.png?width=333&height=245)