Site Settings

The documentation theme can be customized through various site settings. These settings control different aspects of the theme’s functionality and appearance.

Configuration Options

copyLinkButtons

• Type: boolean
• Default: true

Controls the visibility of “copy link” buttons next to headings on documentation pages. When enabled, users can easily copy direct links to specific sections of your documentation.

useViewTransitions

• Type: boolean
• Default: false

Controls whether to enable Astro’s View Transitions API for page transitions. When using Tailwind v4 in development mode, enabling this option may cause visual stuttering. This does not seem to be an issue in production builds.

pagination

• Type: boolean
• Default: true

Controls the visibility of the previous and next navigation buttons on documentation pages.

docsRoute

• Type: string
• Default: docs

This is available if you would like to change the default route for the documentation pages. It updates various links and routes within the documentation theme to match the specified route.

Example Configuration

export const siteSettings: DocsSiteSettingsProps = {
  useViewTransitions: false,  // Disable view transitions
  copyLinkButtons: true,     // Show copy link buttons on docs headings
  docsRoute: "my-docs-route",         // Change the default route for documentation pages
};