Skip to content
These are the docs for Clay 4.x. Go to the latest version (5.x)
On this page

Folders

Folders in docs/ become sections of the navigation, nested as deep as your folders go. A folder only appears when it contains at least one page.

#Title, icon and order

A folder describes itself in an index.md inside it, with the same front matter as a page:

  • docs/guides
    • index.mdthe folder's title, icon and order
    • setup.md
    • deploying.md
docs/guides/index.md
---
title: Guides
icon: fa-solid fa-book-open
order: 3
---
Field Default Purpose
title the first heading of index.md, then the folder name Title in the sidebar, breadcrumbs and search
icon fa-solid fa-folder Font Awesome icon
order none Position among the pages and folders next to it

Without an index.md, a folder is named after its folder name: getting-started becomes “Getting started”.

#A page for the folder

When index.md has text below its front matter, that text is the folder’s page, shown when readers open the folder at its URL (/guides). An index.md with only front matter just names the folder; its page then lists the pages in it. See index pages.

#Folders in other languages

Translate a folder like a page: index.de.md next to index.md gives the folder its German title and German page.

---
title: Guides
order: 3
---

# Guides

Step-by-step guides for …

The order always comes from the original index.md.

Tip

clay edit creates folders with their index.md, and writes the title, icon and order of existing ones. See clay edit.