README.md

 ▄▄▄██▀▀▀█    ██  ██▓ ▄████▄  ▓█████    ▓█████▄  ▒█████   ▄████▄    ██████
   ▒██   ██  ▓██▒▓██▒▒██▀ ▀█  ▓█   ▀    ▒██▀ ██▌▒██▒  ██▒▒██▀ ▀█  ▒██    ▒
   ░██  ▓██  ▒██░▒██▒▒▓█    ▄ ▒███      ░██   █▌▒██░  ██▒▒▓█    ▄ ░ ▓██▄
▓██▄██▓ ▓▓█  ░██░░██░▒▓▓▄ ▄██▒▒▓█  ▄    ░▓█▄   ▌▒██   ██░▒▓▓▄ ▄██▒  ▒   ██▒
 ▓███▒  ▒▒█████▓ ░██░▒ ▓███▀ ░░▒████▒   ░▒████▓ ░ ████▓▒░▒ ▓███▀ ░▒██████▒▒
 ▒▓▒▒░  ░▒▓▒ ▒ ▒ ░▓  ░ ░▒ ▒  ░░░ ▒░ ░    ▒▒▓  ▒ ░ ▒░▒░▒░ ░ ░▒ ▒  ░▒ ▒▓▒ ▒ ░
 ▒ ░▒░  ░░▒░ ░ ░  ▒ ░  ░  ▒    ░ ░  ░    ░ ▒  ▒   ░ ▒ ▒░   ░  ▒   ░ ░▒  ░ ░
 ░ ░ ░   ░░░ ░ ░  ▒ ░░           ░       ░ ░  ░ ░ ░ ░ ▒  ░        ░  ░  ░
 ░   ░     ░      ░  ░ ░         ░  ░      ░        ░ ░  ░ ░            ░
                     ░                   ░               ░

Website

Juice Docs contains documentation for the Juicebox protocol and juicebox.money. Juice Docs is built with Docusaurus 2.

Installation

To run Juice Docs, you need to have yarn installed.

Clone with:

git clone https://github.com/jbx-protocol/juice-docs.git && cd juice-docs

And install with:

yarn

Start a local development server with:

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.

Build with:

yarn build

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

Hosting

We're hosting Juice Docs on Peel's Vercel. If you have any questions, ask in the Peel Discord.

To minimize unecessary builds, either make a PR or push all of your commits at once.

Contributing

Juice Docs are funded and built by JuiceboxDAO. You can contribute by making a pull request. If you're interested in getting more involved, read our Contribution Guide.

Juice Docs are built with Markdown, making it easy for anybody to contribute. If you can read this, you can help!

Static Files

Files in the static directory will be accessible from the base URL. For example, you can access the file in static/img/townhall.webp at https://docs.juicebox.money/img/townhall.webp.

Images

To speed up load times, we use webp images. To convert png files to webp files, run yarn webp. You will need to have cwebp installed for this to work.

Contact

If you would like to contribute or have questions, you can make an issue here on GitHub, join our Discord server, or contact us via juicebox.money.