fan1997/hice-doc

Documentation of the HICE library

Hice文档

文档基于gitbook，部署在github pages上，支持中英文，文档网址为https://pku-hpc.github.io/hice-doc

文档开发流程

前期准备

• nodejs

  由于gitbook是用npm安装的，所以首先本地应配置node环境，直接全局安装可参考链接，或者也可以通过安装nvm来管理node。

• gitbook

  上一步成功后，直接执行

  npm install gitbook -g

  即可成功在本地配置gitbook环境。

修改文档

• 从仓库中克隆最新的文档

  git clone https://github.com/pku-hpc/hice-doc.git

  其中en下为英文文档，zh下为中文文档。

  新增或修改对应的中英文文档，进入对应的目录，增加自己的markdown文件并修改SUMMARY.md（目录结构文件）。

• 本地运行

  提交前先在本地运行，检查修改效果，首先需要安装依赖插件（katex, prism等），在hice-doc/目录下执行：

  gitbook install
  gitbook serve

  服务启动后可根据提示在localhost:4000下查看效果。

• 提交修改

  分为两步，master分支下为文档源码，gh-pages分支下为github pages静态站点的内容，即文档编译后的HTML文件，所以需要首先提交对master源码分支的修改。本地编译后生成的HTML文件在hice-doc/_book下，克隆gh-pages分支到本地

  git clone -b gh-pages https://github.com/pku-hpc/hice-doc.git

  将hice-doc/_book下的内容需拷贝到本地的gh-pages分支文件夹下，最后提交对gh-pages分支的修改。

其它

文档的数学公式由Katex渲染，添加数学公式时需按照对应语法，否则会报错，或显示不正确。

参考链接

gitbook简明教程

发布到Github Pages