Getting started

The installation is quite easy:

1. Clone the repo
2. Fill title & description, configure menu, etc
3. Run

Using yarn

Step 1. Clone

Firstly, you need to clone the codex.docs repository:

Step 2. Configure

Create docs-config.local.yaml for your docs configuration:

You can leave this file empty in order to use default configuration. You can also override some configuration properties. For configuration properties documentation follow this page.

Step 3. Install dependencies and run

You should have node.js version later than 16 and yarn on computer. Then run following commands

Using docker

Step 1. Configure

Create docs-config.yaml for your docs configuration:

You can leave this file empty in order to use default configuration. You can also override some configuration properties. For configuration properties documentation follow this page.

Step 2. Create docker-compose.yaml

You should have docker and docker-compose on your computer. Then you need to run following commands:

Step 3. Run docker-compose

Start using

Open http://localhost:3000 and check that everything works fine.

Then you can see this page: