Page Meta

Reference

Page Meta

Properties

title
stringRequired
The main title of the content - by default visible in navigation and page title
sidebarTitle
string
Title to display in the sidebar navigation
description
string
Display description for SEO/llms.txt purposes
icon
string
Icon identifier for the navigation item
layout
PageLayout "wide" | "page" | "reader"
Layout type for the content display
maxTocDepth
number
Max depth for table of contents
url
string
External URL for the content
copyPage
boolean
If false, hide the copy page button
uniform
PageMetaUniform
Uniform for API Docs references
- PageMetaUniformDetails
  PageMetaUniformDetails
  Uniform details allows to specify more options than just the path, for example eager loading
  path
  stringRequired
  Path to the uniform file / url
  eager
  boolean
  If true, the uniform will be eagerly loaded
- string
  string
contextControls
ContextControls
Page context controls for this page — REPLACES the global
components.contextControls set (an empty array opts the page out).
hidden
boolean
If true, hide from navigation
public
boolean
Access control: if true, this page is public even when defaultAccess is "protected". If false, this page requires authentication even when defaultAccess is "public".
accessGroups
string[]
Access control: groups/roles that can access this page. Users must belong to at least one listed group. Only applies when the page is protected.
tocCard
Optional 'tocCard' for custom cards in the table of contents
- TocCard
  TocCard
  link
  stringRequired
  'link' to the card
  title
  stringRequired
  'title' of the card
  description
  stringRequired
  'description' of the card
  icon
  string
  'icon' of the card
- TocCard[]
  TocCard[]

Theme Navigation Item

Built with

Show your support! Star us on GitHub ⭐️

Star