Code

Code blocks are a core part of technical documentation.

ctrl alt doc supports fenced Markdown code blocks with syntax highlighting.

Basic code blocks #

Specify a language after the opening fence.

const message = 'Hello, world!';

console.log(message);

The language identifier tells ctrl alt doc how the code should be highlighted.

Common languages #

For example:

const greeting = 'Hello, world!';

body {
	margin: 0;
}

pnpm install
pnpm dev

{
	"name": "my-project",
	"private": true
}

Copying code #

Rendered code blocks include a copy button so readers can copy the contents directly.

The button copies the code without the surrounding formatting.

Inline code #

Use single backticks for short pieces of code inside a paragraph.

Run `pnpm dev` to start the development server.

Run pnpm dev to start the development server.

What's next? #

For larger examples, use a standard fenced code block and specify the appropriate language.