Skip to main content
CodivDocs

Quick Start

Get your documentation site live in under 5 minutes.

1. Create a project

Sign up at app.codivdocs.com and create a new project. Pick a name and URL slug — your docs will be available at {slug}.codivdocs.com.

2. Connect GitHub

Click Install GitHub App on your project page. Select the repository containing your documentation files.

3. Add your docs

Create a docs/ folder in your repo with MDX files:

my-repo/
├── codiv.config.json
└── docs/
    ├── introduction.mdx
    ├── quickstart.mdx
    └── api/
        └── authentication.mdx

Each MDX file needs frontmatter:

---
title: My Page Title
description: A brief description of this page.
---

# My Page Title

Your content here...

4. Configure navigation

Create a codiv.config.json in your repo root:

{
  "name": "My Docs",
  "navigation": [
    {
      "group": "Getting Started",
      "pages": [
        "docs/introduction",
        "docs/quickstart"
      ]
    }
  ]
}

5. Push and deploy

git add .
git commit -m "docs: add initial documentation"
git push

Your docs are now live. Every subsequent push will automatically update your documentation site.

Last updated April 12, 2026