Configuration

Pass a factory to provideNgxDocs. The factory runs inside Angular's injection context and returns the site configuration.

provideNgxDocs(() => ({
  brand: {
    name: "Acme",
    logoSrc: "/acme.svg",
    homeLink: "/",
  },
  headerNav: [
    { label: "Docs", routerLink: "/docs" },
    { label: "GitHub", href: "https://github.com/acme/docs" },
  ],
  search: {
    type: "local",
    placeholder: "Search documentation…",
    maxResults: 8,
  },
  feedback: { enabled: true },
  sidebar: getSidebar(),
})),

Configuration groups

• brand controls the logo, name, and home link.
• sidebar is the ordered page tree generated from content metadata.
• search selects local search or Algolia DocSearch.
• locales enables locale-aware links and the language picker.
• ai exposes MCP and agent-readable documentation endpoints.
• comments, analytics, and feedback enable optional integrations.
• frontmatter extends or validates project-specific page metadata.

Keep application-specific values in the app config and reusable behavior in the corresponding ngxdocs package.