Contribute
基本信息
本站由基于 React 的 Docusaurus 构建。
网站部署
下载
$ git clone https://github.com/Howardzhangdqs/shiercoding_web.git
$ cd shiercoding_web
提示
亦可使用 GitHub Desktop 来克隆仓库与上传代码。
依赖安装
$ pnpm i
信息
Node.js自带的包管理工具npm既不好用,在国内也很慢,也很占存储空间。推荐使用yarn或者pnpm作为包管理工具:
- pnpm
- cnpm
- yarn
pnpm通过类似快捷方式的方法,让所有的依赖包都只在你的电脑上安装一次。
$ pnpm i
cnpm是淘宝镜像源的配套包管理工具,在国内的下载速度较为可观。
$ cnpm i
yarn包管理工具是由facebook公司开发的,能扁平化处理依赖,减少node_modules体积减少。
$ yarn install
预览
$ npm start
构建
$ npm run build
构建成果在/build/下。
预览构建的内容
$ npm run serve
也可使用http-server进行预览:
$ npx http-server build
内容撰写
你可以在目录/docs/下找到 /docs/ 下的全部源代码。
Docusaurus 所使用的 Markdown 语法与通用的略有差别,具体请见 Markdown Features。
内容贡献
成为仓库管理员
向 zjh@shanghaiit.com 发送邮件,说明你的身份。经过考核后即可无限制提交 Pull requests。
直接贡献
向项目https://github.com/Howardzhangdqs/shiercoding_web.git提交 Pull requests,项目管理员看到后会合并该分支。
修改限制
由于经费限制,每月仅能构建300分钟,每次仓库更新构建时长约为一分半,故请管理员不要过于频繁合并PR,也不要通过包含过大文件的PR。
其他
页面右上角的搜索只能在构建后使用,预览模式后不可用。
Stackblitz沙箱(直接在浏览器中构建服务器)
数学公式渲染使用 引擎,可能会有部分 功能不兼容,具体请见 官网