构建网站

Jupyter Book 构建网站

地震“学”所有教程网站都使用文档生成工具 Jupyter Book 构建。 读者可以按照如下步骤在自己的计算机上构建网站。

安装 git 和 Python

以下步骤假定用户已安装版本控制工具 git 和 Python。

若未安装 git，可以使用以下命令安装或更新 git：

若未安装 Python，建议通过 :doc:Anaconda <software:anaconda/index> 来安装和管理 Python。

Note

以下步骤以地震“学”科研入门教程为例。 构建其他文档时只需做简单替换即可：

• 构建文档地震“学”软件: 将 seismology101 改成 software

• 构建文档地震“学”参考书: 将 seismology101 改成 seismology

1. 下载文档源码

   # 克隆源码，并进入源码目录
   $ git clone --depth=50 https://github.com/seismo-learn/seismology101.git
   $ cd seismology101
   

2. 创建虚拟环境

   $ conda env create -f environment.yml
   

3. 编译生成 HTML 格式的文档

   $ conda activate seismo-learn
   $ make html
   

4. 生成的文档位于 _build/html/ 目录下，直接用浏览器打开 _build/html/index.html 即可在本地预览。

Hugo 构建网站

地震学主站和地震“学”链接是由静态网站生成器 Hugo 构建生成的，具体构建方法请参考他们 源码网址里的 README.md 文件。此外，地震“学”链接使用的主题是我们基于 Bootstrap 框架和 Font Awesome 精美图标自定义的。