MkDocs-Material-Dark-Theme

A dark theme for the Material for MkDocs theme.

Notice

Official dark theme support is currently worked on at squidfunk/mkdocs-material and is scheduled for a v5.X release, so this repository will hopefully become obsolete in the future.

Usage

If you only want to use the dark theme you can just copy the css files and add them using the extra_css yaml notation.

However this repository also enables the use of a web app. To also use this the theme folder and theme_dir configuration is required.

The following assumes you want to use both dark theme and webapp ability.

Copy the files

Copy the contents of this repository to your root documentation path.

==documentation
  ==docs
    ==SomeSubFolder
    ==stylesheets
      --dark_theme.css
      --codehilite.css
    --MyDocument.md
    etc.
  ==theme
    --main.html
    --manifest.json
    etc.

Modify your configuration

Then add the following to your mkdocs.yaml file:

# Documentation and theme
theme:
  name: 'material'
  custom_dir: 'theme'
  palette:
    primary: 'green'
    accent: 'light green'

extra_css:
  - stylesheets/dark_theme.css
  - stylesheets/codehilite.css

Make sure to change values like name and icons in manifest.json to your liking.

Docker

This project contains a simple docker file to get started with MkDocs-Material, which contains:

• mkdocs
• mkdocs-material
• pymdown-extensions

and runs the mkdocs development server (that includes auto-rebuild) which hosts the content in /data on port 8000.

This image does not contain the dark theme configuration. Since it lives inside your project folder afafik there is no easy way to merge the files of this repo with your custom project data, so you have to do this youself.

To start it use a command similar to this:

sudo docker run -it \
  --name mkdocs-material \
  --mount type=bind,source=/mymkdocsproject,target=/data \
  -p 8000:8000 \
  markusressel/mkdocs-material