Write pages for your site

You write pages the same way as in any brain. See Write and edit files. This page covers how they turn into a site.

Pages and addresses

• Each markdown file is a page. Its address is its path without .md: getting-started/install.md is at /getting-started/install.
• Each folder becomes a section in the navigation.
• index.md in a folder is that section's own page. The index.md at the top is your home page.

Titles and descriptions

Readers and search engines see two of a page's properties:

• title: the page's name. Without one, ako uses the first heading.
• description: one sentence shown under the title and in search results.

---
title: Install the CLI
description: Install the command-line tool on macOS, Windows or Linux.
---

No other property is published.

Links

Link to another page with a relative link to its .md file:

See [Install the CLI](../getting-started/install.md).

ako rewrites it to the page's address when you publish. Links to a section of a page, like install.md#on-windows, work too.

Images

Add images as PNG, JPEG, GIF, WebP or AVIF files in the brain, and link to them with a relative path. SVG images aren't shown, and neither is raw HTML in a page.

What is never published

These stay private, whatever they contain:

• AGENTS.md
• ground-truth/ and routines/
• .brain/, and any file or folder whose name starts with a dot

Everything else is published. There's no private drafts folder, so keep working notes in another brain.

What readers get

Every published page has a contents list for its headings, previous and next links, and Copy as markdown. The site has search, and an llms.txt that lists every page so AI tools can read your docs.