https://github.com/strappazzon/mkdocs-material-midnight

🎨 A Material for MkDocs theme
https://github.com/strappazzon/mkdocs-material-midnight

midnight-theme mkdocs-material mkdocs-material-theme theme

Last synced: 12 months ago
JSON representation

🎨 A Material for MkDocs theme

• Host: GitHub
• URL: https://github.com/strappazzon/mkdocs-material-midnight
• Owner: Strappazzon
• License: mit
• Created: 2025-05-20T19:27:05.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-06-14T19:31:52.000Z (12 months ago)
• Last Synced: 2025-06-26T07:08:53.386Z (12 months ago)
• Topics: midnight-theme, mkdocs-material, mkdocs-material-theme, theme
• Language: CSS
• Homepage:
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          



  





  mkdocs-material-midnight





  A Material for MkDocs theme



[![Badge](https://img.shields.io/badge/Material%20for%20MkDocs-%3E%3D%209.6-2094f3?style=for-the-badge&labelColor=4051b5&logo=materialformkdocs&logoColor=fff)](https://squidfunk.github.io/mkdocs-material/)  

[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) 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](https://gkb.strappazzon.xyz) on my gaming Knowledge Base.

## Getting Started

To use this theme in your Material for MkDocs documentation:

1. Add this repository as a submodule

   ```sh

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

   ```

2. Reference the stylesheet in your configuration

   ```yaml

   extra_css:

     - path/to/midnight.css

   ```

## Recommended Configuration

```yaml

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

```