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 a project name, documentation site title, and optional GitHub URL, then writes those values into the generated project. The GitHub URL populates the navbar's socials.github link so readers can find the repository. It does not configure an edit-source link for pages. 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.',
	theme: { sidebar: true },
	navbar: {
		logo: '/logo.svg',
		logoAlt: 'My project',
		socials: {
			github: 'https://github.com/owner/project'
		}
	},
	footer: {
		showBranding: true,
		text: 'Documentation for my project.',
		links: [{ label: 'Project', href: 'https://example.com' }]
	},
	icons: {},
	callouts: {
		note: { label: 'Note', icon: 'info' }
	}
});

Configuration is optional beyond title and description. Use only the fields supported by CtrlAltDocConfig: theme.sidebar, navbar.logo, navbar.logoAlt, navbar.socials, footer branding, footer text and links, custom icons, and callouts.

Write your first page #

Create:

docs/
└── index.md

Then start the development server.