https://github.com/mangrovedao/mangrove-docs
🌴 Documentation for Mangrove
https://github.com/mangrovedao/mangrove-docs
decentralized-exchange documentation gitbook smart-contracts
Last synced: about 2 months ago
JSON representation
🌴 Documentation for Mangrove
- Host: GitHub
- URL: https://github.com/mangrovedao/mangrove-docs
- Owner: mangrovedao
- Created: 2021-10-24T13:35:26.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T12:56:49.000Z (over 1 year ago)
- Last Synced: 2024-04-22T14:02:27.840Z (over 1 year ago)
- Topics: decentralized-exchange, documentation, gitbook, smart-contracts
- Language: HTML
- Homepage: https://docs.mangrove.exchange
- Size: 61.9 MB
- Stars: 0
- Watchers: 6
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/mangrovedao/mangrove-core), for using the SDK in [mangrove.js](https://github.com/mangrovedao/mangrove.js), and the bots in [mangrove-bots](https://github.com/mangrovedao/mangrove-bots).
The published version is available at https://docs.mangrove.exchange.
## Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```console
$ yarn
```
### Local Development
```console
$ 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
```console
$ 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](https://github.com/grnet/docusaurus-terminology) for creating handy glossary terms.
```console
$ 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:
```console
$ USE_SSH=true yarn deploy
```
Not using SSH:
```console
$ GIT_USER= 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.