mkdocs-material-midnight

A Material for MkDocs theme

Material for MkDocs theme inspired by Discord and Reddit color palettes. For consistency, this theme will modify the default color scheme as well.

You can see how it looks here on my gaming Knowledge Base.

Getting Started

To use this theme in your Material for MkDocs documentation:

1. Add this repository as a submodule

   git submodule add "https://github.com/Strappazzon/mkdocs-material-midnight"

2. Reference the stylesheet in your configuration

   extra_css:
     - path/to/midnight.css

Recommended Configuration

theme:
  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: white
      toggle:
        icon: material/lightbulb-auto-outline
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/lightbulb-off
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/lightbulb-on-outline
  icon:
    admonition:
      bug: material/bug
      danger: material/close-octagon
      example: material/format-list-bulleted-square
      info: material/information-box
      note: material/pencil-box
      question: material/help-box
      tip: material/lightbulb
    annotation: material/pencil-box
    edit: material/text-box-edit
    view: octicons/markdown-16