This is a demo announcement, dismissible and configured in site.json.
Switch to latest

Writing Pages

Front matter reference and how headings drive navigation, search and deep links.

Every page in Bora is a Markdown file. Hugo converts it to HTML and the theme wires it into the sidebar, table of contents and search index automatically.

Front matter

Every page needs at least a title. Everything else is optional:

yaml 
---
title: "Page Title"
description: "One-line summary for cards, search results and link previews."
weight: 10
cover: "/docs/media/special-banner.png"
draft: false
---
Field Description
title Page heading, sidebar label and search result title.
description Card subtitle on section pages, search snippet, <meta name="description"> and social card text.
weight Sidebar and prev/next ordering. Lower values appear first.
cover Per-page Open Graph banner, overriding social.cover from site.json.
draft Drafts build only with hugo server -D and get a badge on section cards.

Headings

Use ## (h2) and ### (h3) to structure pages. The theme turns them into:

  • the “On this page” column on wide screens, with the current section highlighted while scrolling
  • search results that deep-link to the exact section, shown as “Page > Heading”
  • anchor links: hover any heading and click the link icon to copy the URL

#### and deeper headings render normally but stay out of the table of contents and search chunks. That is a signal to keep page structure flat.

Section index pages

A directory needs an _index.md to appear in the sidebar and get a card grid on wide screens. The minimal version:

yaml 
---
title: "Section Title"
description: "What this section covers."
weight: 10
---

You can add body content below the front matter and it appears above the card grid.

Everything you can put on a page

  • Admonitions: note, tip, important, warning and caution callouts
  • Tabs: synced multi-variant content blocks
  • Code blocks: titles, highlighted lines, line numbers and Mermaid
  • Images and links: figures, lightbox, remote images
  • Shortcodes: diagrams, PDF embeds, OpenAPI, steps, cards and more

Standard Markdown works too: tables, blockquotes, task lists and \``mermaid` diagrams all render out of the box.

Edit this page