Taichi Website

A static website built with VuePress and Bulma for Taichi, its documentation, tutorials, events etc.

For documentation contributors

To update existing documentation or create new documentation, please always work on website/docs/develop ONLY, and merge back to that directory, versions should be cut-off following the guidelines below. Please carefully consider if you really need to update a doc that belongs to an older version!

Prerequisites

You need to install the following before setting up this project:

yarn

On macOS, you can install the above by:

brew install yarn

On Debian-based Linux distribution, you can install the above by:

sudo apt install yarn

For Arch Linux, use the following command:

sudo pacman -S yarn

To install yarn on Windows, you need to install Node.js first. You can check it using node -v‘ in the terminal. After it's verified, download the Yarn installer(.smi) from the official yarn website and install it. To verifiy the installation, use yarn --version.

Setup

Install all of the dependencies by:

# from the root of the project
yarn --cwd=website install

Local Development

In order to spin up the dev server locally for development:

yarn --cwd=website dev

Routing

The routing table of the entire site can be found at website/.vuepress/config.js. See VuePress Docs for more details.

Custom Styles

Most of the customization is done in 3 places:

The plugin section of website/.vuepress/config.js.
website/.vuepress/style/index.styl.
website/.vuepress/style/palette.styl.

Build

To build the static site, from the root, run:

yarn --cwd=website build

Formatting

To format with default code styles, from the root, run:

yarn --cwd=website format

Note: this will by default format most of the files in the project (including markdown, javascript files), which can result in a large set of changes, so run this with caution!

Versioning

This site ships with a built-in versioning mechanism, to cut-off a new version from the current develop docs:

Finish all of the work on website/docs/develop.
Run the following command with the new version number:

yarn --cwd=website createVersion ${VERSION} # for example, 0.1.0

This will make the following changes:

Add the new version to website/.vuepress/versions.json.
[English Docs] Copy all documentation from website/docs/develop to website/docs/{VERSION}
[中文文档] Copy all documentation from website/zh/docs/develop to website/zh/docs/{VERSION}

The above changes should be regarded as a transaction and shall be reverted altogether manually if needed.

Deployment

This website currently hosted on Github Pages at https://taichi.graphics. The gh-pages branch is hosting the static files.

The deployment is automatically done when Pull Requests are merged to master branch. It can also be triggered manually here.

Credits

This website is built on top of the wonderful VuePress along with a list of great plugins, thanks to all of the contributors of the plugins that are used by this site!

Acknowledgements (documentation, website and i18n)

Thanks to all contributors who have contributed to the development of Taichi documentation, community and website. Please navigate to the members page of Taichi website to see the full acknowledgements. Specifically, for whoever have contributed to the taichi-docs-zh-cn translations, please see the following chart!
Taichi中文文档及其社区、网站能够如此快速地成长，离不开每一位贡献者的工作和付出，感谢大家！请移步至 Taichi网站的社区成员页面来查看完整的鸣谢列表。特别地，我们在这里将曾参与过 taichi-docs-zh-cn 仓库翻译文档的贡献者特别列出。

WoodenJin / taichi.graphics