Documentation

Documentation is generated using Hexo.

To run the documentation locally, clone the relax repo, if you haven't already, and cd into the docs folder:

git clone [email protected]:relax/relax.git
cd relax/docs

Install the dependencies with Yarn:

yarn

Now to start the documentation app just run:

yarn dev

After generating you can now open http://localhost:4000/relax/, when making changes you don't need to run anything or even refresh the browser window as it should reload on changes by itself :-)

Deployment (relax members only)

yarn deploy