Skip to content

MkDocs / Configuration

Guides on MkDocs Material configuration and customization.

Basic Configuration

mkdocs.yml

site_name: My Site
site_url: https://example.com
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes

Theme Features

  • Navigation
  • Search
  • Dark mode
  • Responsive design

Customization

Color Palette

theme:
  palette:
    - scheme: default
      primary: teal
      accent: deep orange

Font Settings

theme:
  font:
    text: Roboto
    code: Roboto Mono

Plugins

Core Plugins

  • search: Search functionality
  • minify: HTML optimization
  • redirects: Redirect management

Extended Plugins

  • blog: Blog functionality
  • tags: Tag system
  • social: OGP image generation

Advanced Configuration

Custom CSS

:root {
  --md-primary-fg-color: #1976d2;
  --md-accent-fg-color: #ff5722;
}

Custom JavaScript

document.addEventListener('DOMContentLoaded', function() {
  // Custom functionality implementation
});