The docmd.config.js file is the central brain of your documentation. It defines how your content is structured, how it looks, and how both humans and AI interact with it.

The Configuration File

We recommend using the defineConfig helper. It provides full IDE autocomplete and type-checking, making it much easier to discover available settings.

const { defineConfig } = require('@docmd/core');

module.exports = defineConfig({
  title: 'My Project',
  url: 'https://docs.myproject.com',
  // ... settings
});

Core Settings (V3 Schema)

docmd v0.5.0 introduces a streamlined V3 schema. While legacy keys are still supported, we recommend transitioning to these modern labels:

Branding

Customize how your brand appears in the header and browser tabs.

logo: {
  light: 'assets/logo-dark.png', // Logo for light mode
  dark: 'assets/logo-light.png',  // Logo for dark mode
  href: '/',                      // Click destination
  alt: 'Company Logo'             // Accessibility text
},
favicon: 'assets/favicon.ico',

Layout Architecture

docmd follows a component-based layout system. You can toggle and configure different parts of the UI via the layout object.

The Options Menu

The Options Menu consolidates utility buttons like Search, Theme Switching, and Sponsorship links.

layout: {
  optionsMenu: {
    position: 'header', // Options: 'header', 'sidebar-top', 'sidebar-bottom', 'menubar'
    components: {
      search: true,
      themeSwitch: true,
      sponsor: 'https://github.com/sponsors/your-profile'
    }
  }
}

::: note
If optionsMenu.position is set to header or menubar but the target container is disabled or null, it automatically falls back to sidebar-top.
:::

Engine Features

Fine-tune how docmd processes your files.

minify: true,           // Minifies production HTML, CSS, and JS
autoTitleFromH1: true,  // Automatically use the first # Heading if Frontmatter title is missing
copyCode: true,         // Adds a 'Copy' button to all code blocks
pageNavigation: true,   // Adds 'Next' and 'Previous' links at the bottom of pages

Legacy Support

If you are upgrading from an older version of docmd, the following keys are automatically mapped to the V3 schema:

• siteTitle → title
• siteUrl / baseUrl → url
• srcDir / source → src
• outDir / outputDir → out