Interep docs

Interep documentation website.

Our documentation website was generated with Docusaurus. Please, check https://docusaurus.io/docs for more information.

🛠 Install

Clone this repository and install the dependencies:

git clone https://github.com/interep-project/docs.git
cd docs && yarn

📜 Usage

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.

Build

yarn build

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

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true 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.

Notice: You can find all the markdown documentation files in the docs folder.