Skip to content

Customizing the Site

You can control almost every aspect of this site by editing the mkdocs.yml configuration file.

✏️ Site Metadata

Change the site name, description, and base URL:

site_name: Docs-as-Code Starter Kit
site_description: A lightweight example of modern documentation workflows
site_url: https://yourdomain.github.io/docs-site/

Theme Customization

Control appearance and branding via the theme: section:

theme:
  name: material
  palette:
    - scheme: default
      primary: deep orange
      accent: black
    - scheme: slate
      primary: green
      accent: lime
  font:
    text: Inter
    code: Fira Code

  logo: assets/logo.png
  favicon: assets/favicon.ico

The site nav is defined in mkdocs.yml using the nav: key:

nav:
  - Home: index.md
  - Getting Started:
      - Installation: install.md
      - Structure: structure.md
  • Nest sections with indentation
  • Each file listed must exist in the docs/ folder
repo_url: https://github.com/yourname/yourproject
repo_name: yourname/yourproject

This will show a GitHub icon in the site header.

Enable Plugins

MkDocs supports plugins like search or macros. Example:

plugins:
  - search

Additional plugins can be installed and added here.

See mkdocs.org/user-guide/configuration for all available options.