Skip to content
No description, website, or topics provided.
Makefile
Branch: master
Clone or download

Latest commit

huangsuyu and suyu Improve research and clean up (#227)
* change search index and clean up

* change search index and clean up

Co-authored-by: suyu <huangsuyu@huangsuyudeMacBook-Pro.local>
Latest commit d4e3284 Mar 30, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Improve research and clean up (#227) Mar 30, 2020
utils Added Makefile, swagger2markup tooling Dec 26, 2018
.gitignore fix format Oct 12, 2019
.gitmodules Added Makefile, swagger2markup tooling Dec 26, 2018
Makefile makefile: use binance-chain/swagger-markdown Feb 1, 2019
README.md Merge pull request #220 from binance-chain/swagger Feb 21, 2020
mkdocs.yml Improve research and clean up (#227) Mar 30, 2020
rpc-openapi.json Add files via upload Jan 6, 2020
swagger.json upgrade to openapi3 Jan 14, 2020
swagger.yml add error msg to account not found (#218) Feb 20, 2020

README.md

Binance Chain Documentation

This documentation site is automatically deployed to https://binance-chain.github.io.

The main documentation is stored in the docs folder and is generated with Mkdocs.

How to Change the Docs

  • 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 all markdown format.
  • Once you finish the editing, run mkdocs serve in the Binance-Chain directory, then you can preview the site via http://127.0.0.1:8000/.

Generating HTTP API Markdown

Use the following command to generate the Markdown documentation for the HTTP API from this repo's root directory:

$ make build-markdown-http-docs

Generating JavaScript SDK Markdown

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

Generate swagger doc

$  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
You can’t perform that action at this time.