gatsby-oiwiki

正在开发中的基于 gatsby 的渲染框架。欢迎您点击下方链接入群并参与项目。

Demo：https://ng.oi-wiki.org/

TG 群：https://t.me/joinchat/GaEGzhcWGl8-1CSjdhi9kA

如何参与

一般情况下，你需要把本项目先 Fork 一份。

在本地开发

准备好 Git 和 NodeJS。注意，NodeJS 版本应当大于等于12. 请勿使用 taobao 等 npm 镜像。

Linux

git clone https://github.com/{你的 GitHub 用户名}/gatsby-oi-wiki.git # 将仓库克隆至本地
cd gatsby-oi-wiki # 进入仓库文件夹
yarn install --ignore-optional # 安装依赖，如果你可以解决国际联网问题，可以使用 yarn install

Windows

首先，在安装 NodeJS 时，请确保你选择了“Install Additional Tools for Node.js”这一项，如果没有安装，可以在开始菜单里找到这一项并安装。

然后克隆本项目的仓库，并安装依赖

git clone https://github.com/{你的 GitHub 用户名}/gatsby-oi-wiki.git
cd gatsby-oi-wiki
yarn install --ignore-optional # 安装依赖，如果你可以解决国际联网问题，可以使用 yarn install

至此，准备工作已经完成；接下来，是三种基本操作：

# 开发环境
yarn develop # 运行开发服务器
yarn build # 构建项目并生成静态文件
# 清除缓存
yarn clean # 当你发现浏览的界面与预期不同时，可以尝试清理缓存
              # Gatsby的缓存存放在两个目录中：public 目录存储静态页面文件，.cache 目录存储临时文件
              # 你也可以通过手动删除这两个文件夹达到清理效果

使用 Gitpod 开发

我们适配了 Gitpod。它相当于是一个云端的 VS Code。打开 https://gitpod.io/#https://github.com/{你的用户名}/gatsby-oi-wiki，Gitpod 就会创建一个 Workspace。

不要重复创建 Workspace，每一次打开 https://gitpod.io/#https://github.com/{你的用户名}/gatsby-oi-wiki 的链接都会创建一个新的 Workspace。第一次创建了之后就可以直接打开 gitpod.io 找回你原来的 Workspace 就行了，请节省资源。

然后，它会自动执行 yarn install 和 yarn develop 的命令，右下角弹出一个 A service is available on port 8000 的窗口，点击 Open Browser 就可以打开预览了。

你还可以在底栏的 Open Ports 菜单选择 Make Public 让大家都能看到预览页面。

当你第一次 push 时，Gitpod 会向 GitHub 申请读写权限，确认即可。

最后，提出你可爱的 PR~

---

Tips

• 先不用加入 wiki 中大量的文件，sidebar 和子文件夹均测试过已经 work 了
• Latex 中不能出现 \left<\right>，否则会 gg。要写成\left\langle\right\rangle。
• netlify 好像会把 url 最后的 / 给自动去掉。检查内链用的页面：https://oi-wiki-ng.netlify.com/math/poly/newton/
• 由于插件的存在，建议直接使用 jpg/png 图片，插件会自动生成对应的 webp 图片。
• 可以借鉴学习的设计：
  • https://www.tensorflow.org/api_docs/python/tf/keras/layers/ReLU
  • https://source.android.com/
  • http://material.io
  • https://cloud.google.com/vision/docs/quickstart

要加 feature 可以随时提出～

License

Deploy