Atlas Docs is a Markdown-based static site generator for documentation, paired with a Codex workflow that turns project context into a polished docs site.
^ generate docs like these ^
The repository has two related parts:
src/atlas_docs/: the reusable Python package and CLIATLAS_DOCS_FORMAT.md: the source format the generator compiles
The Codex skill for this workflow is named create-documentation. When packaged for Codex, it is intended to be a standalone bundle that includes its own SKILL.md, references, and vendored atlas_docs scripts.
Given an Atlas source directory, the CLI builds a browsable static HTML documentation site.
The create-documentation skill sits one layer above that. It is meant to:
- inspect a local repository or research a non-local project
- write Atlas source files such as
metadata.md,navigation.md,assets.md, andcontent/*.md - build a final
docs_site/index.html
From the repository root:
py -m pip install -e .That installs the atlas-docs command defined in pyproject.toml.
atlas-docs init my-docs
atlas-docs build my-docs --out dist/index.html --theme atlas_dark
atlas-docs serve my-docs --port 8000atlas-docs serve rebuilds on save and refreshes the browser automatically for local preview work.
If you do not want to install the package, you can run it from source:
set PYTHONPATH=src
py -m atlas_docs.cli build my-docs --out dist/index.htmlAtlas separates source content from rendering assets:
docs/
metadata.md
navigation.md
assets.md
content/
*.md
The format is defined in ATLAS_DOCS_FORMAT.md.
src/atlas_docs/
cli.py
loader.py
markdown.py
renderer.py
theme.py
templates/
themes/
static/
ATLAS_DOCS_FORMAT.md
pyproject.toml
README.md
The intended Codex skill name is create-documentation.
Depending on the Codex surface, invocation may look like either of these:
/create-documentation document this project
$create-documentation document this project
A packaged standalone skill bundle should contain:
create-documentation/
SKILL.md
agents/openai.yaml
references/ATLAS_DOCS_FORMAT.md
references/atlas-workflow.md
scripts/atlas_docs/
That bundle should use the vendored scripts/atlas_docs package so the skill remains portable instead of depending on this repository being installed in editable mode.