This documentation site is automatically deployed to https://docs.binance.org/.
The main documentation is stored in the docs
folder and is generated with Mkdocs.
- install
mkdocs
- In most times, you only need to add new pages with links on existing pages, such as index.md
or *.md in
api-reference
fold. These files are allmarkdown
format. - Once you finish the editing, run
mkdocs serve
in theBinance-Chain
directory, then you can preview the site via https://127.0.0.1:8000/.
Use the following command to generate the Markdown documentation for the HTTP API from this repo's root directory:
$ make build-markdown-http-docs
In a javascript-sdk directory cloned in this repo's parent directory, use the yarn build:docs
command to generate the file, then copy the generated file in docs/jsdoc.md
over the existing docs/api-reference/js-sdk/jsdoc.md
:
$ cp ./docs/jsdoc.md ../docs-site/docs/api-reference/js-sdk/jsdoc.md
$ swagger-codegen generate -i ./rpc-openapi.json -l html2 -o ./site/rpc-swagger
$ swagger-codegen generate -i ./swagger.json -l html2 -o ./site/api-swagger