Websites

contributors

Yao Jiayuan

last updating date

2021-05-22

---

Hugo is used to build the static websites, e.g., Prof. Ping Tong’s homepage. We use the hugo module, wowchemy.

Sphinx is used to build the documentation,e.g., MIG_Docs. We use the Read the Docs Sphinx theme.

Jekyll is used to build MIGG-NTU’s Github User Page, using the modernist theme.

All the websites and documentation are hosted at GitHub using GitHub Pages. GitHub Actions or Travis CI is used to build and deploy the websites and documentation.

Website Settings

Websites	Generators	Themes	Hostings	Building & Deployment
MIG homepage	Hugo	Wowchemy Module	GitHub Pages	Travis CI
MIG_Docs	Sphinx	Read the Docs Sphinx	GitHub Pages	GitHub Actions
SeisTomo_Tutorials	Sphinx	Read the Docs Sphinx	GitHub Pages	GitHub Actions
geosciences_Myanmar	Sphinx	Read the Docs Sphinx	GitHub Pages	GitHub Actions
MIGG-NTU.github.io	Jekyll	modernist	GitHub Pages	GitHub

Hugo

Hugo is the world’s fastest framework for building static websites:

• Install | Releases

• Documentation | 中文文档

Themes:

Wowchemy (GitHub) is a popular website builder for Hugo. It is now a Hugo Module and previously was a Hugo Theme called hugo-academic. Some Wowchemy Templates are available, e.g., Academic Starter (previous academic-kickstart).

You can edit the website on the local PC using Wowchemy along with some prerequisites. Please refer to Wowchemy Documentation for more details.

Hugo provides a lot of useful Themes which can be also used to build our websites.

Website examples:

• uOttawa Geophysics | GitHub

• GMT 中文社区 | GitHub

• Dongdong Tian’s homepage | GitHub

• Jiayuan Yao’s homepage | GitHub

Tutorials:

We can refer to some parts of those tutorials, because the settings in our websites are a little different.

• 借助 Hugo 和 Academic 主题在 github

• academic 主题

• Academic 实现 Github Page 个人博客

Sphnix

Sphnix is a tool that makes it easy to create intelligent and beautiful documentation.

• Install

• Documentation: Using Sphinx

Themes:

• HTML Theming

• Read the Docs Sphinx provided by Read the Docs

Documentation examples:

• GMT Documentation | GitHub

• GMT 中文手册 | GitHub

• SAC 参考手册 | GitHub

Tutorials:

• How to document with Sphinx tutorial

• Sampledoc: a very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers

• 使用单个仓库配置 GitHub Pages + Sphinx

• 如何用Sphinx、GitHub、ReadtheDocs 搭建写书环境

GitHub Pages

GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website.

• Documentation

• 如何把 Hugo 生成的博客托管在 GitHub Pages

• 发布到Github Pages

• 解决Github Pages 和 Github .md 文件图片不显示

Github Actions

GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want.

Tutorials:

• Quick Start

• GitHub Actions 入门教程

• GitHub Actions 自动部署

• GitHub Action 一键部署

Travis CI

Travis CI is a continuous integration (CI) platform used to build and test code changes, provide immediate feedback on the success of the change, and manage deployments and notifications. Please refer to the Documentation for more details.

Tutorials:

• Travis CI Tutorial

• 持续集成服务 Travis CI 教程

• 使用 Travis CI 自动部署 Hugo 博客