Shoalrun documentation framework
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Reference

Site footer

Add link columns, a bottom row of links, and a short text line below every page.

Updated
Read as Markdown

The footer sits below every page, after the navigation and article. Configure it under site.footer. Without that setting, the site has no footer.

docs.config.yaml
site:
  title: Example documentation
  footer:
    columns:
      - title: Guides
        links:
          - { label: Get started, href: /start }
          - { label: Authentication, href: /guides/auth }
      - title: Company
        links:
          - { label: Status, href: "https://status.example.com" }
          - { label: Contact support, href: "mailto:support@example.com" }
    links:
      - { label: Privacy, href: /legal/privacy }
      - { label: Terms, href: /legal/terms }
    text: © 2026 Example, Inc.

Columns appear first, side by side on wide screens and stacked on phones. Below them, a bottom row shows text on the left and links on the right. Every part is optional, but the footer needs at least one of them.

These settings configure the footer text and its links.

Setting Required Value
columns No A list of link groups. Each has a title and a links list with at least one link.
links No Links for the bottom row, such as legal pages.
text No One line of plain text, such as a copyright notice. The build escapes it, so HTML and Markdown show as typed.

Each link takes a label and an href. An href is a site-root path such as /start, an http or https URL, or a mailto: link. External http and https links get rel="noopener". The build rejects any other URL scheme, including javascript:.

Footer links don't take a style. Use header links for buttons and calls to action.

Layout and themes

The footer uses the page's theme tokens, so each theme preset and palette restyles it. On landing and splash layouts, it matches the narrower landing width. The CSS and theme reference lists its classes.

The footer is part of the HTML page only. Markdown twins, search results, and /llms.txt do not include it.

No matching documents.