Mangrove documentation

This repo holds both developer and end-user documentation for Mangrove. For developers, sections cater both to interacting directly with the core contracts and for using the strat library in mangrove-core, for using the SDK in mangrove.js, and the bots in mangrove-bots.

The published version is available at https://docs.mangrove.exchange.

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

(Note: This command does not process glossary terms.)

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

(Note: This command does not process glossary terms.)

Process glossary terms and build

mangrove-docs uses docusaurus-terminology for creating handy glossary terms.

$ yarn run docgen

This command processes glossary terms and replaces (inline) term reference syntax (%%term|term-id%%) with references to term-pages as well as hover short explanations. Afterwards, it runs a full build (see above).

Deployment

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.