Codex Documentation Manager | Project Configuration

Overview

The project as a whole is configured by a codex.yml file, located at the project root.

Fields

name

required

String

The display name for the project. This will be displayed in the top header.

build_path

optional

String

A path relative to the project path to place compiled files into.

repo_url

optional

String

A URL to the project's code repository. If specified a code link will appear in the header.

To disable this simply omit the field from the config or set it to ~.

project_url

optional

String

A URL to the project's main page. If specified a home link will appear in the header.

To disable this simply omit the field from the config or set it to ~.

base_url

optional

String

Base URL can be set to allow the site to be hosted in a sub path. This value will be prefixed to static asset URLs, navigation URLs, and all relative links inside documents.

Example Configuration

name: My Project
build_path: dist
repo_url: https://github.com/me/project
project_url: https://myproject.com