Configure Multiple Documentation Sites

CamelMind lets you publish multiple independent documentation sites from a single project.

Each site has its own:

• Navigation
• URL namespace
• Sidebar
• Content structure

This makes it easy to organize different types of documentation while managing everything in one repository. For example, you might publish:

• Product Documentation
• API Documentation
• SDK Documentation
• Internal Documentation

Each documentation site is defined in versions.yml.

Define your documentation sites

Each entry in versions.yml registers a documentation site.

versions:
  - id: docs
    stable: true
    label: "Documentation"
    nav: nav/docs.yml

  - id: api
    stable: true
    label: "API Reference"
    nav: nav/api.yml

Each site references its own navigation file, allowing every documentation collection to have its own page structure, sidebar, and organization.>

How URLs are generated

Navigation entries always define their own page slugs without worrying about prefixes.

For example:

slug: /getting-started/overview

CamelMind determines the final URL based on the documentation site's position in versions.yml. The first documentation site is treated as the primary site and keeps its URLs unchanged. Every additional site is automatically prefixed with its id.

For example:

versions:
  - id: docs
    label: "Documentation"
    nav: nav/docs.yml
  - id: api
    label: "API Reference"
    nav: nav/api.yml
  - id: sdk
    label: "SDK"
    nav: nav/sdk.yml

If each navigation file contains the same slug:

slug: /getting-started/overview

CamelMind generates these URLs:

Independent navigation

Each documentation site can organize its pages differently.

For example:

nav/
├── docs.yml
├── api.yml
└── sdk.yml

Each navigation file is completely independent, allowing you to organize pages differently for each documentation site. For example:

• Product documentation can focus on tutorials and guides.
• API documentation can organize endpoints by resource.
• SDK documentation can group pages by programming language.

See Configure Navigation to learn how to structure each navigation file.

Default documentation site

If your project only contains a single documentation site, you only need one entry:

versions:
  - id: docs
    label: Documentation
    nav: nav/nav.yml

Most projects only need a single navigation file. Add additional entries when you want to publish separate documentation collections.

Configure the default navigation file

CamelMind looks for nav/nav.yml by default.

You can change this in camelmind.config.ts.

const config: CamelMindConfig = {
  navFile: "nav/nav.yml",
}

This setting defines the default navigation file used by the primary documentation site.

Common use cases