Orb Community Website

Orb documentation can be accessed here.

This documentation is made in mkdocs, so for local development follow the steps below:

⚠️ Some mkdocs features do not render properly in pure markdown. Please, use the local server locally.

Setup your Python environment

You need to have python >= 3.8 installed

Create a virtual environment: $ python3 -m venv name_of_virtualenv

Activate your virtual environment: $ source name_of_virtualenv/bin/activate

Install the required libraries: $ pip install -r requirements.txt

Start the server

$ mkdocs serve

For more information access mkdocs documentation and material theme documentation.