Code Atlas / Documentation framework

Documentation, built your way.

An open-source framework that fits your Next.js project. Host it yourself, compose your own pages, and keep control of your content.

Get started Explore components

Code Atlas documentation showing navigation, a quick start guide, and code examples

Quick StartSet up your first documentation pages

Your docs. Your infrastructure. Your rules.

A framework should give you a starting point and the freedom to make it yours. Code Atlas leaves the decisions with you.

Host it your way.

Deploy on your own server or a platform you choose. Your docs run with your application, without a Code Atlas hosting subscription.

Your hosting
Your repository
Your deployment

your-docs/Example project structure

app
- docs
  [[...slug]]
  page.tsx
content
- introduction.mdx
- quickstart.mdx
codealtas.config.ts

Runs in environments that support Next.js server rendering.

Free and open source.

Free to use. Source code you can read and change. Keep your documentation in your project, without a required paid service.

Inspect it. Adapt it. Make it yours.

Fits your project.

Keep your routes, layouts, and pages. Bring in the documentation components you need without replacing your application.

Explore layouts and pages

A small framework. Room to build.

Write the content. Connect the pages. Extend the experience with components that belong to your project.

Explore the components

Next.jsReactTypeScript

Markdown & MDX

Write guides in Markdown. Use MDX when your explanation needs an interactive component.

getting-started.mdx

# Getting started

Ready-made components

Tabs for alternatives. Steps for workflows. File Tree for project structure.

Tabs Steps File Tree

Customizable by design

Compose layouts, register your own React components, and support light and dark themes.

Compose your layout

Flexible navigation

Group pages into categories. Set their order. Give readers a clear next step.

Plain text. Real components.

One MDX file, with an interactive result.

Writing with MDX

welcome.mdxSource

# Make yourself at home

Your content. Your components.

<Tabs>
  <Tab name="Markdown">
    Write guides in plain Markdown.
  </Tab>
  <Tab name="React">
    Bring your own React components.
  </Tab>
</Tabs>

Live previewTry the tabs below

Make yourself at home

Your content. Your components.

Write guides in plain Markdown.

Start fresh. Or bring your project.

A new home for your docs

Start with a Next.js project and the included layouts. Add your first pages, then make it your own.

Part of your existing app

Connect documentation to your Next.js and React app while keeping your application structure.

Get started

The path to your first pageInteractive guide

Prepare your project

1 / 3

Start with Next.js and React.

Use a new project or your existing application. Check the Quick Start guide for supported versions and setup instructions.

Read the prerequisites

Use the arrows to explore the setup. Detailed instructions are in the Quick Start guide.

Build your documentation. Keep it yours.

Read the documentation