Zum Hauptinhalt springen

Configuration Guide

Main configuration happens in docusaurus.config.ts and sidebars.ts.

Site-Level Configuration​

In docusaurus.config.ts, define:

  • title and tagline
  • url and baseUrl
  • organizationName and projectName
  • onBrokenLinks behavior
  • i18n locales

Docs Configuration​

Inside presets/classic docs config:

  • sidebarPath: file that defines docs navigation
  • editUrl: link for edit-this-page
  • routeBasePath: base route if using additional docs plugin instances

Add navigation entries for docs, blog, contact, and external links.

Best practice:

  • Keep top-level nav short and clear
  • Put secondary links in footer
  • Make docs entry always visible

In sidebars.ts you can:

  • use autogenerated sidebars from folder structure
  • define manual categories for precise order

Autogenerated is fast for early phases. Manual is better for stable docs IA.

Search Plugin​

For local search plugin:

  • install plugin package
  • add plugin entry in docusaurus.config.ts
  • build site and confirm search index generated

i18n Configuration​

You can add locales under i18n:

  • defaultLocale: main language
  • locales: all supported languages

Then translate docs under i18n/<locale>/.