Creating a new project
The easiest way to generate a new project is with the init command using the CLI. This will generate a codex.yml in the project path and an example article.
codex init
By default, the this assumes the current path is the root of the project. the --root-path flag can be used to specify an alternate location.
Layout of the project
The project layout is meant to be free form. Sub paths are used to group articles. By default, the directory name is used to name the grouping and this is used to build the navigation menu. For simple situations, nothing needs to be done other than logically organize articles into folders.
To customize the groups, a group.yml file can be placed inside a folder. This will allow configuring things like a custom display name, whether it should appear in the navigation menu, and if so, in what order.
root folder- codex.yml- grouping folder- article.mdgrouping folder- group.yml- article.md