Markdown syntax

Makit renders Markdown as page content and enables GitHub Flavored Markdown by default. This page pairs each source form with its rendered result.

Headings, paragraphs, and links

# Page title

Separate paragraphs with a blank line. Use **emphasis**, `inline code`, and [links](https://github.com/mika-f/makit).

## A section

Rendered result:

Page title

Separate paragraphs with a blank line. Use emphasis, inline code, and links.

A section

The first H1 becomes the page title unless metadata supplies title. Headings receive IDs, and the table of contents includes H2–H3 by default.

Lists and quotations

- An unordered item
- Another item

1. First step
2. Next step

> A quotation can provide context or cite a source.

- [x] Complete
- [ ] Not yet complete

Rendered result:

• An unordered item
• Another item

1. First step
2. Next step

A quotation can provide context or cite a source.

• Complete
• Not yet complete

Code blocks

Give a fence a language to enable syntax highlighting. The filename and lineNumbers attributes enrich the display.

```ts src/makit.config.ts lineNumbers
export default { title: "My Documentation" };
```

Rendered result:

export default { title: "My Documentation" };

Code annotations highlight change states without rendering the annotation itself.

```ts
const changed = true; // [!code highlight]
const added = true; // [!code ++]
const removed = false; // [!code --]
```

Rendered result:

const changed = true;
const added = true;
const removed = false;

In markdown, md, and mdx fences, annotations remain visible as example text.

GitHub-style alerts

> [!WARNING]
> Run `makit check` before publishing a production site.

Rendered result:

Use NOTE, TIP, IMPORTANT, WARNING, or CAUTION to signal severity.

Tables

| Setting   | Meaning    |
| --------- | ---------- |
| `title`   | Site name  |
| `siteUrl` | Public URL |

Rendered result:

Use colons in the separator row to align each column. A colon on the left, both sides, or right aligns the column left, center, or right respectively.

| Left | Center | Right |
| :--- | :----: | ----: |
| a    | b      | c     |

Rendered result:

Raw HTML is disabled by default. Configure HTML, Shiki, external links, plugins, and the table-of-contents range in the configuration reference.