Implementation:Confident ai Deepeval Docusaurus Config

Knowledge Sources	Confident_ai_Deepeval Docusaurus
Domains	Documentation, Developer_Tooling
Last Updated	2026-02-14 09:30 GMT

Overview

Central Docusaurus configuration file that defines the entire structure, plugins, theme settings, navigation, search, and analytics for the DeepEval documentation website.

Description

The Docusaurus Config (`docs/docusaurus.config.js`) is the primary configuration file for the DeepEval documentation site hosted at deepeval.com. It is a JavaScript module that exports a Docusaurus `Config` object. The configuration registers five content-docs plugin instances (main docs, tutorials, guides, integrations, changelog), each with its own sidebar and edit URL pointing to the GitHub repository. It uses the `@docusaurus/preset-classic` preset with blog support, LaTeX rendering via remark-math/rehype-katex, Mermaid diagram support, SASS styling, Algolia search, Google Tag and Plausible analytics, and a Night Owl code theme via Prism with custom magic comment highlights.

Usage

This file is consumed by the Docusaurus build system when building or serving the documentation site. Modify it when adding new documentation sections, changing navigation, updating search configuration, or adjusting site-wide theme settings.

Code Reference

Source Location

• Repository: Confident_ai_Deepeval
• File: docs/docusaurus.config.js
• Lines: 1-303

Signature

/** @type {import('@docusaurus/types').Config} */
module.exports = {
  plugins: [
    'docusaurus-plugin-sass',
    ['@docusaurus/plugin-content-docs', { id: 'tutorials', ... }],
    ['@docusaurus/plugin-content-docs', { id: 'guides', ... }],
    ['@docusaurus/plugin-content-docs', { id: 'integrations', ... }],
    ['@docusaurus/plugin-content-docs', { id: 'changelog', ... }],
  ],
  title: 'DeepEval by Confident AI - The LLM Evaluation Framework',
  url: 'https://deepeval.com',
  presets: [['@docusaurus/preset-classic', { ... }]],
  themes: ['@docusaurus/theme-mermaid'],
  themeConfig: { navbar: { ... }, algolia: { ... }, footer: { ... }, prism: { ... } },
};

Import

// This is a Docusaurus config file, not directly imported by user code.
// It is loaded automatically by the Docusaurus build system.
// Dependencies:
const remarkMath = require('remark-math').default;
const rehypeKatex = require('rehype-katex').default;
const { themes: prismThemes } = require('prism-react-renderer');

I/O Contract

Inputs

Name	Type	Required	Description
Sidebar files	JS modules	Yes	`sidebars.js`, `sidebarTutorials.js`, `sidebarGuides.js`, `sidebarIntegrations.js`, `sidebarChangelog.js`
Custom CSS	SCSS	Yes	`src/css/custom.scss` for theme customization
Static assets	Files	Yes	Favicon, logo SVG, social card image in `static/` directory

Outputs

Name	Type	Description
Config object	Object	Docusaurus configuration consumed by the build system to produce the static documentation site

Usage Examples

Building the Documentation Site

# Navigate to the docs directory
cd docs

# Install dependencies
npm install

# Start development server
npm run start

# Build for production
npm run build

Adding a New Documentation Section

// To add a new section, add a plugin entry in docusaurus.config.js:
[
  '@docusaurus/plugin-content-docs',
  {
    id: 'new-section',
    path: 'new-section',
    routeBasePath: 'new-section',
    sidebarPath: require.resolve('./sidebarNewSection.js'),
    editUrl: 'https://github.com/confident-ai/deepeval/edit/main/docs/',
    showLastUpdateAuthor: true,
    showLastUpdateTime: true,
  },
],

Related Pages

No outgoing graph connections. This is a standalone documentation infrastructure configuration.