Page Configuration NEW

Page configuration allows you to customize the behavior and appearance of individual pages in your Goyo documentation site. These settings are defined in the front matter of each content file using the [extra] section.

Note: This page demonstrates both the toc_expand and badge features - notice how the Table of Contents on the right is fully expanded by default, and there's a "NEW" badge next to the page title!

Badge Indicator

You can add a badge indicator to any page or section by including a badge field in the [extra] section:

+++
title = "Your Page Title"
description = "Your page description"

[extra]
badge = "NEW"
+++

The badge will appear as a styled indicator positioned to the right of the page title. This is useful for highlighting:

• New content
• Beta features
• Updated pages
• Important notices

Common badge values:

• NEW - For newly added content
• BETA - For features in beta
• UPDATED - For recently updated content
• WIP - For work in progress

If the badge field is not set, no badge will be displayed.

Table of Contents (TOC) Configuration

TOC Expand

toc_expand

• toc_expand: Controls whether the Table of Contents (TOC) on the page should be expanded by default.
  • false (default): TOC sections are collapsed and will automatically expand/collapse based on scroll position
  • true: TOC sections are expanded by default and remain expanded regardless of scroll position

Default Behavior (toc_expand = false or not set):

+++
title = "My Page"
description = "Page description"

[extra]
# TOC will be collapsed by default and auto-expand based on scroll
+++

When toc_expand is not set or set to false, the TOC behaves dynamically:

• Sections with sub-headings are collapsed by default
• As you scroll, the current section automatically expands
• Other sections collapse to maintain a clean view

Expanded TOC (toc_expand = true):

+++
title = "My Page"
description = "Page description"

[extra]
toc_expand = true
+++

When toc_expand is set to true:

• All TOC sections are expanded by default
• All sections remain expanded regardless of scroll position
• Useful for pages with many short sections where you want to see all headings at once

Example Usage

Here's a complete example of a page with expanded TOC:

+++
title = "API Reference"
description = "Complete API documentation with all endpoints visible"
weight = 10

[extra]
toc_expand = true
+++

# API Reference

This page shows all API endpoints with the TOC fully expanded.

## Authentication
Details about authentication...

## Endpoints
### GET /api/users
### POST /api/users
### DELETE /api/users

## Error Codes
### 400 Bad Request
### 401 Unauthorized
### 404 Not Found

With toc_expand = true, readers can see all endpoints and error codes in the TOC at once, making it easier to navigate the API reference.