Project Structure

Every CamelMind project follows the same directory structure. Most of your work will happen in certain folders, while the rest powers the framework behind the scenes.

This guide explains what each folder is for and when you'll need to edit it.

my-docs/
├── app/                      # Next.js routes and rendering
├── components/               # UI and MDX components
├── content/                  # Documentation pages
├── lib/                      # Internal utilities
├── nav/
│   └── nav.yml               # Sidebar navigation
├── public/                   # Images and downloads
├── scripts/                  # Build utilities
├── camelmind.config.ts       # Site configuration
├── versions.yml              # Documentation versions
├── next.config.ts            # Next.js configuration
├── .env.example              # Configuration template; duplicate to .env.local before running
├── package.json
└── tsconfig.json

CamelMind content directory structure

The CamelMind content/ directory stores every MDX documentation page for your site structure and authoring workflow.

content/
├── getting-started/
│   └── overview.mdx
├── guides/
│   └── writing-docs.mdx
└── reference/
    └── configuration.mdx

Unlike other documentation frameworks, CamelMind does not derive URLs from your folder structure. Define your URLs directly in nav.yml to take complete control over your site's navigation.

The nav/nav.yml file

nav.yml serves as the single source of truth for your sidebar menu and page URLs. Every entry maps a slug (the public URL) to a file (the MDX source):

nav:
  - label: "Getting Started"
    dropdown: false
    noDropdown: true
    items:
      - label: "Project Structure"
        slug: /getting-started/project-structure
        file: content/getting-started/project-structure.mdx
        roles: []

Register every content/ page here to make it reachable; you can also assign a page to multiple slugs using distinct labels or roles. See Configure Navigation reference for every field.

CamelMind versions.yml file configuration

The CamelMind versions.yml configuration file defines all published documentation versions and multi-version site settings.

versions:
  - id: "latest"
    label: "Latest"
    stable: true
    nav: nav/nav.yml

A fresh scaffold ships with a single latest version. Add entries here when you're ready to publish multiple versions side by side.

CamelMind primary configuration file camelmind.config.ts

The camelmind.config.ts file acts as the primary configuration blueprint for CamelMind site settings, authentication options, and global properties.

const config: CamelMindConfig = {
  title: "My Docs",
  tagline: "Documentation made simple.",
  url: process.env.CAMELMIND_URL ?? "http://localhost:3000",

  contentDir: "content",
  navFile: "nav/nav.yml",
  versionsFile: "versions.yml",

  auth: { enabled: false, requireLogin: false, provider: "dev-mock", /* ... */ },
  links: { github: "https://github.com/you/your-repo" },
  ai: { llmsTxt: { enabled: false, directive: "" } },
}

CamelMind reads most secrets and environment-specific values (auth toggles, the site URL) from environment variables in .env.example / .env.local rather than hardcoding them here.

The CamelMind app/ application directory

The app/ directory contains the Next.js application routes and logic that power your CamelMind documentation site.

CamelMind components directory and React UI modules

The components/ directory contains all React UI components, layout elements, and custom MDX widgets used throughout your CamelMind site.

• Site chrome — Nav/, Sidebar/, Toc/, Breadcrumbs/, PageNav/, Search/, SectionCards/, ApiReference/, and similar folders render the surrounding site UI (top nav, sidebar, table of contents, search modal).
• components/mdx/ — the components available directly inside your .mdx content: Callout, Steps, Tabs, Details, Icon, LLMOnly, and LLMIgnore.

See Use MDX Components for how to use each one in your content.

The CamelMind lib/ utility directory

The lib/ directory contains core TypeScript modules responsible for parsing content and navigation in CamelMind.

CamelMind scripts/ build and export utilities

The scripts/ directory houses standalone automation scripts for generating offline release artifacts in CamelMind.

See Offline Package and PDF Export for how these fit into a release workflow.

CamelMind root configuration files

The following table outlines the purpose of each root configuration file in your CamelMind project:

CamelMind next steps and related resources

Explore these resources to continue building and customizing your CamelMind documentation site.