Copy page

Writing

Code Blocks

APIToGo supports code blocks in Markdown using the Shiki syntax highlighting library.

See examples for all supported languages in the Syntax Highlighting section.

Syntax Highlighting

Code blocks are text blocks wrapped around by strings of 3 backticks. You may check out this reference for the specifications of MDX.

Code
```js
console.log("Every repo must come with a mascot.");
```

The code block above will render as:

Code
console.log("Every repo must come with a mascot.");

Inline Code

You can highlight inline code using either:

Regular backticks without language specification:

Code
`console.log("Hello World")`

Result: console.log("Hello World")

or with the tailing curly colon syntax:

Code
`console.log("Hello World"){:js}`

Result: console.log("Hello World")

For more details, see the Shiki Rehype documentation.

You can add a title to code blocks by adding a title attribute after the backticks:

Code
```tsx title="hello.tsx"
console.log("Hello, World!");
```

Result:

hello.tsx
console.log("Hello, World!");

For a complete list of supported languages and their aliases, see the Shiki Languages documentation.

Advanced Syntax Highlighting

There are multiple ways to enhance syntax highlighting:

• Line highlighting
• Word highlighting
• Line numbers: showLineNumbers
• Title: title

Example:

Code
```tsx {4-6} /react/ title="Example.tsx" showLineNumbers
import { useEffect } from "react";

function Example() {
  useEffect(() => {
    console.log("Mounted");
  }, []);

  return <div>Hello</div>;
}
```

Result:

Example.tsx
import { useEffect } from "react";

function Example() {
  useEffect(() => {
    console.log("Mounted");
  }, []);

  return <div>Hello</div>;
}

Configuration

You can configure syntax highlighting in your apitogo.config.tsx:

apitogo.config.ts
import { defaultLanguages, type ApitogoConfig } from "@lukoweb/apitogo";

const config: ApitogoConfig = {
  // ...
  syntaxHighlighting: {
    themes: {
      light: "vitesse-light",
      dark: "vitesse-dark",
    },
    // Extend default languages with additional ones
    // Aliases like "lisp" are resolved automatically
    languages: [...defaultLanguages, "rust", "ruby", "php", "powershell"],
  },
};

For a complete list of available themes and languages, see the list of Shiki themes and Shiki languages.

Default Supported Languages

By default, APIToGo supports the following languages for syntax highlighting:

• Shell - shellscript, bash, sh, zsh
• JavaScript/TypeScript - javascript, typescript, jsx, tsx
• Data formats - json, jsonc, yaml
• HTML/CSS/XML - html, css, xml
• Markdown - markdown, mdx
• Python - python
• Java - java
• Go - go
• GraphQL - graphql

Additional languages can be added via syntaxHighlighting.languages in your config. Languages not in the list fall back to plain text with a console warning. You can use aliases (e.g. lisp for common-lisp) and they will resolve automatically.

ANSI Code Blocks

You can use the ansi language to highlight terminal outputs with ANSI escape sequences. This is useful for displaying colored terminal output, styled text, and other terminal-specific formatting.

Terminal Output
colored foreground
bold text
dimmed text
underlined text
reversed text
strikethrough text
underlined + strikethrough text

Usage:

Code
```ansi title="Terminal Output"
colored foreground
bold text
dimmed text
underlined text
reversed text
strikethrough text
underlined + strikethrough text
```

For more details on ANSI highlighting, see the Shiki documentation.