Installation

Codex provides binaries for the following platforms:

• Linux

• MacOS (Intel)

• MacOS (Apple Silicon)

• Windows

Linux/MacOS via shell script

On Linux Codex can be installed via a installation shell script

curl --proto \
'=https' \
--tlsv1.2 \
-LsSf https://github.com/5Sigma/codex/releases/latest/download/Codex-installer.sh \
| sh

NixOS

Codex can be installed via a flake in NixOS by adding it to your packages list:

(builtins.getFlake "github:5Sigma/codex").packages.x86_64-linux.default

Windows via Power Shell script

On windows Codex can be installed via Power Shell

irm https://github.com/5Sigma/codex/releases/download/v0.1.0/Codex-installer.ps1 | iex

Windows via installer

An installer is available for windows at here.

Binary Downloads

Binary downloads are available in the Github Release Page.

Setup a new project

To setup a Codex project within another project run codex init and specify a project folder. This can be a sub folder of another project.

codex init support/docs

This will create the specified path and generate an example codex.yml file at the project root. You can configure this file if needed.

Adding a new article

Articles are written in Markdown, and should have the .md extension. Articles can be added in the project folder, or within a subfolder. Subfolders automatically create groupings that are used in the navigation menu.

Example: To setup a new article at the url /overview/getting-started, which will also setup an Overview group in the navigation. Create a file at:

project_root/overview/getting-started.md

This file should have front matter that defines its title, such as:

---
title: Getting started
---

# Some tile

Some content

Viewing the project

To view the project run codex serve from the root of the project. This will spawn a web server that will serve the project at http://localhost:8080.