正在开发中的基于 gatsby 的渲染框架。欢迎您点击下方链接入群并参与项目。
TG 群:https://t.me/joinchat/GaEGzhcWGl8-1CSjdhi9kA
一般情况下,你需要把本项目先 Fork 一份。
准备好 Git 和 NodeJS。注意,NodeJS 版本应当大于等于10. 请勿使用 taobao 等 npm 镜像。
你可能需要一些工具来解决国际互联网访问问题,并配置HTTP_PROXY
和HTTPS_PROXY
两个环境变量。
git clone https://github.com/{你的 GitHub 用户名}/gatsby-oi-wiki.git #将仓库克隆至本地
cd gatsby-oi-wiki #进入仓库文件夹
npm install #安装依赖
首先,在有管理员权限的终端中执行下面的代码,它可能会耗费较长的时间,请耐心等待。
npm install -g windows-build-tools
然后克隆本项目的仓库,并安装依赖
git clone https://github.com/{你的 GitHub 用户名}/gatsby-oi-wiki.git
cd gatsby-oi-wiki
npm install
至此,准备工作已经完成;接下来,是三种基本操作:
# 开发环境
npm run develop # 运行开发服务器
# 构建静态页
npm run build # 构建项目并生成静态文件
npm run serve # 为刚刚生成的文件运行本地服务器
# 清除缓存
npm run clean # 当你发现浏览的界面与预期不同时,可以尝试清理缓存
# Gatsby的缓存存放在两个目录中:public 目录存储静态页面文件,.cache 目录存储临时文件
# 你也可以通过手动删除这两个文件夹达到清理效果
我们适配了 Gitpod。它相当于是一个云端的 VS Code。打开 https://gitpod.io/#https://github.com/{你的用户名}/oi-wiki-ng
,Gitpod 就会创建一个 Workspace。
不要重复创建 Workspace,每一次打开
https://gitpod.io/#https://github.com/{你的用户名}/oi-wiki-ng
的链接都会创建一个新的 Workspace。第一次创建了之后就可以直接打开gitpod.io
找回你原来的 Workspace 就行了,请节省资源。
然后,它会自动执行 npm install
和 npm run develop
的命令,右下角弹出一个 A service is available on port 8000 的窗口,点击 Open Browser 就可以打开预览了。
你还可以在底栏的 Open Ports 菜单选择 Make Public 让大家都能看到预览页面。
当你第一次 push 时,Gitpod 会向 GitHub 申请读写权限,确认即可。
最后,提出你可爱的 PR~
- 先不用加入 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 图片。
- 可以借鉴学习的设计:
要加 feature 可以随时提出~