This documentation website is built using Docusaurus 2, a modern static website generator.
yarn
Start a local development server and open a browser window. Most changes are reflected live without having to restart the server.
yarn start
After updating the open-api/btc.yaml, this command need to be run to re-generate all docs in open-api/btc:
yarn gen-api-docs
This command generates static content in the /build directory and can be served using a static content hosting service like S3 or GitHub Pages.
yarn build
Using SSH:
USE_SSH=true yarn deploy
Not using SSH:
GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.