README.md

   1 [![Word Art](https://raw.githubusercontent.com/24OI/OI-wiki/master/docs/images/wordArt.png)](https://oi-wiki.org/)
   2
   3 # 欢迎来到 **OI Wiki**！
   4
   5 [![Travis](https://img.shields.io/travis/OI-WIKI/OI-wiki.svg?style=flat-square)](https://travis-ci.org/OI-wiki/OI-wiki)
   6 [![Progress](https://img.shields.io/badge/Progress-88%25-brightgreen.svg?style=flat-square)](https://github.com/OI-wiki/OI-wiki)
   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/OI--wiki-join%20Telegram%20chat-brightgreen.svg?style=flat-square)](https://t.me/OIwiki)
   9 [![QQ](https://img.shields.io/badge/OI--wiki-join%20QQ%20group-brightgreen.svg?style=flat-square)](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** 正在完善各大方向的基础知识，以便于初学者更好地学习。
  24
  25 **OI Wiki** 基于 **OI**，却不会局限于 **OI**。**OI Wiki** 会努力完善以下内容：
  26
  27 - 应用在 **ICPC** 竞赛中的进阶知识
  28 - 竞赛中出现的优质题目
  29 - 与面试、实际应用相结合的经验
  30
  31 关于上述待完善内容，请参见 **OI Wiki** 中的 [Projects](https://github.com/OI-wiki/OI-wiki/projects)，详细列举了正在做的事情以及待做事项。
  32
  33 与此同时， **OI Wiki** 源于社区，提倡 **知识自由**，在未来也绝不会商业化，将始终保持独立自由的性质。
  34
  35 * * *
  36
  37 ## 部署
  38
  39 本项目目前采用 [MkDocs](https://github.com/mkdocs/mkdocs) 部署在 [oi-wiki.org](https://oi-wiki.org)。
  40
  41 我们在 [status.oi-wiki.org](https://status.oi-wiki.org) 维护了一份镜像站列表，它们的内容和 [oi-wiki.org](https://oi-wiki.org) 都是相同的。
  42
  43 当然，也可以在本地部署。（**需要 Python 3**）
  44
  45 [点击查看用 asciinema 录制的流程](https://asciinema.org/a/220681)
  46
  47 **如果遇到问题，可以查阅 [F.A.Q.](https://oi-wiki.org/intro/faq/) 来了解更多信息。**
  48
  49 ```bash
  50 git clone https://github.com/OI-wiki/OI-wiki.git --depth=1
  51
  52 cd OI-wiki
  53
  54 # 安装 mkdocs
  55 pip3 install -U -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
  56
  57 # 使用我们的自定义主题（不是必须执行）
  58 chmod +x ./scripts/build.sh && ./scripts/build.sh
  59
  60 # 两种方法（选其一即可）：
  61 # 1. 运行一个本地服务器，访问 http://127.0.0.1:8000 可以查看效果
  62 mkdocs serve -v
  63
  64 # 2. 在 site 文件夹下得到静态页面
  65 mkdocs build -v
  66
  67 # 获取 mkdocs 的命令行工具的说明（解释了命令和参数的含义）
  68 mkdocs --help
  69 ```
  70
  71 我们现在在服务器端渲染 MathJax ，如果希望实现类似效果，可以参考 [netlify_build.sh](https://github.com/OI-wiki/OI-wiki/blob/master/scripts/netlify_build.sh)。（需要安装 Node.js）
  72
  73 ### 镜像
  74
  75 ```bash
  76 # Coding 上的镜像仓库和 GitHub 仓库的内容相同
  77 git clone https://git.dev.tencent.com/scaffrey/OI-wiki.git
  78 ```
  79
  80 ### 离线版
  81
  82 可以使用 `gh-pages` 分支的内容（CODING 上面的分支名叫 `coding-pages`）
  83
  84 ```bash
  85 git clone https://git.dev.tencent.com/scaffrey/OI-wiki.git -b coding-pages
  86 ```
  87
  88 本地启动一个 http 服务器可能会更方便一些。
  89
  90 ```bash
  91 # 如果是 python3
  92 python3 -m http.server
  93 # 如果是 python2
  94 python2 -m SimpleHTTPServer
  95 # 有些环境下找不到名叫 python3/python2 的可执行文件，不妨运行 python 试试
  96 ```
  97
  98 ### Docker
  99
 100 详见 [Docker 部署](https://oi-wiki.org/intro/docker-deploy/)
 101
 102 * * *
 103
 104 ## 如何参与完善 OI Wiki
 105
 106 我们非常欢迎你为 **OI Wiki** 编写内容，将自己的所学所得与大家分享。
 107 具体的贡献方式在 [如何参与](https://oi-wiki.org/intro/htc/)。
 108
 109 * * *
 110
 111 ## 版权声明
 112
 113 <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 />
 114 除特别注明外，项目中除了代码部分均采用<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) 进行许可。
 115
 116 换言之，使用过程中您可以自由地共享、演绎，但是必须署名、以相同方式共享、分享时没有附加限制，
 117 而且需要为 GitHub 仓库点赞（Star）。
 118
 119 而如果你想要引用这个 GitHub 仓库，可以使用如下的 bibtex：
 120
 121 ```
 122 @misc{oiwiki,
 123   author = {OI Wiki Team},
 124   title = {OI Wiki},
 125   year = {2016},
 126   publisher = {GitHub},
 127   journal = {GitHub Repository},
 128   howpublished = {\url{https://github.com/OI-wiki/OI-wiki}},
 129 }
 130 ```
 131
 132 * * *
 133
 134 ## 鸣谢
 135
 136 本项目受 [CTF Wiki](https://ctf-wiki.github.io/ctf-wiki/) 的启发，在编写过程中参考了诸多资料，在此一并致谢。
 137
 138 非常感谢一起完善 **OI Wiki** 的 [小伙伴们](https://github.com/OI-wiki/OI-wiki/graphs/contributors) 和为 **OI Wiki** 捐赠的 [朋友们](https://oi-wiki.org/intro/thanks/) ！！
 139
 140 <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>
 141
 142 特别感谢 [24OI](https://github.com/24OI) 的朋友们的大力支持！
 143
 144 <img src='https://i.loli.net/2018/12/07/5c0a6e4c31b30.png' alt='QVQNetWork' width=233>
 145
 146 鸣谢 QVQNetwork 赞助的服务器。