This is the project for the official API documents of Huobi. This README will introduce how this project is structured and how to work with it.
Huobi's API documentation is generated with Slate. This project is an fork of https://github.com/lord/slate slate.
Huobi currently supports two versions of API (v1, v2) and two languages of API documents (English, Chinese), so we have a total of four versions of API documents sit in four branches: v1_en, v1_cn, v2_en, v2_cn. To access the web page of a specific version you can visit https://huobi.github.io/api_doc/{version}/{language}, e.g. for v1 english version visit https://huobi.github.io/api_doc/v1/en.
- Just need to make changes to
./source/index.html.mdin specific branch and commit, let CI complete next two steps.
-
Checkout the target version's branch, e.g. if you want to update v1 chinese documents, checkout v1_cn
-
Make changes to source/index.html.md in this branch and commit
-
Run deploy.sh to deploy the changes to the website.
-
Confirm the result on the web page, if all look good, push the changes.
-
Checkout master branch
-
Make the common file changes
-
Commit and push the changes
-
Checkout each version's branch, merge/cherry-pick, then run deploy.sh
There are two main types of changes: appearance and content.
- Change logo: https://github.com/lord/slate/wiki/Changing-the-Logo
- Customize style: https://github.com/lord/slate/wiki/Custom-Slate-Themes
- Change content markdown: https://github.com/lord/slate/wiki/Markdown-Syntax
https://github.com/lord/slate/wiki/Installing-Slate