8000 GitHub - magnuspl/mkdocs: Project documentation with Markdown.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

magnuspl/mkdocs

 
 

Repository files navigation

MkDocs-Material-Dark-Theme

A dark theme for the mkdocs-material theme

Example Image

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: 'material'
theme_dir: 'theme'

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

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

About

Project documentation with Markdown.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 80.6%
  • JavaScript 7.6%
  • HTML 7.1%
  • CSS 4.7%
0