Installation

Getting a documentation site running should be straightforward.

Install #

Requires Node.js 20.19+ or 22.12+. Start with the project creator, install dependencies, and run the development server:

npm create ctrlaltdoc@latest my-docs
cd my-docs
npm install
npm run dev

It asks for your documentation site title and optional GitHub repository URL, then writes those values into ctrlaltdoc.config.ts. Press Enter to accept the suggested values.

For an existing project, install the framework with your package manager:

pnpm add ctrl-alt-doc

or:

npm install ctrl-alt-doc

Create your configuration #

A minimal configuration looks like this:

import { defineConfig } from "ctrl-alt-doc";

export default defineConfig({
  title: "My Documentation",
  description: "Documentation for my project.",
});

Write your first page #

Create:

docs/
└── index.md

Then start the development server.