Example Docs

Global Settings

Global settings are configured in docs.config.ts and apply to every page in your documentation.

Configuration File

import { defineDocs } from "@farming-labs/docs";

export default defineDocs({
  entry: "docs",
  metadata: {
    titleTemplate: "%s – My Docs",
    description: "My awesome documentation",
  },
  themeToggle: {
    enabled: true,
    default: "dark",
  },
});

Available Options

OptionTypeDefaultDescription
entrystring"docs"Directory containing docs pages
metadataobjectSEO metadata configuration
themeToggleobject{ enabled: true }Dark/light mode toggle
navobjectNavigation title and URL
sidebarobjectSidebar configuration