Full Configuration Reference

Every available mkdocs.yml option for the DAP theme.

Standard MkDocs options

site_name: My Project              # Required
site_url: https://example.com      # Strongly recommended (SEO, sitemap)
site_description: Description
site_author: Your Name
docs_dir: docs
repo_url: https://github.com/user/repo
repo_name: user/repo
copyright: "© 2024 Name"

Theme block

theme:
  name: null                        # Required — disables built-in themes
  custom_dir: themes/dap            # Required — points to the theme folder
  favicon: assets/img/favicon.ico   # Optional — set custom favicon

extra.language / color_scheme / accent_color

extra:
  language: en           # en | es | custom
  color_scheme: dark     # dark | light
  accent_color: green    # green | cyan | purple | pink | orange | red

extra.sidebar

extra:
  sidebar:
    image: assets/img/avatar.png   # relative to docs/
    name: Display name
    tagline: Short subtitle
    links:
      - platform: github           # renders icon
        url: https://...
      - title: Custom Text         # renders text pill
        url: https://...

extra.navmenu

extra:
  navmenu:
    - title: Page
      url: /path/
    - title: Section
      children:
        - title: Child
          url: /path/child/
          children:               # unlimited depth
            - title: Deep
              url: /deep/

extra.analytics

extra:
  analytics:
    provider: google
    property: G-XXXXXXXXXX        # GA4 or UA-XXXXXXXX-X
    cookie_consent: true          # GDPR/LOPD banner
    privacy_policy: /privacy/     # optional banner link

extra.seo

extra:
  seo:
    og_image: assets/img/og.png
    twitter_site: "@handle"
    twitter_creator: "@handle"

extra.social

extra:
  social:
    - platform: github
      url: https://github.com/user

Supported platforms: github twitter x linkedin instagram discord youtube mastodon facebook twitch reddit npm pypi email website

Per-page frontmatter

---
title: Custom Title
description: Custom description
image: assets/img/og-page.png
noindex: true
---

Plugins

plugins:
  - search
# Do NOT add "sitemap" — built into MkDocs automatically
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - admonition
  - pymdownx.details
  - attr_list
  - tables
  - toc:
      permalink: true