mkdocs-mpgtheme-plugin 0.0.1

MkDocs plugin to add some MPG branding to the Material for MkDocs theme

MkDocs Material MPG Theme

A MkDocs plugin that makes the Material for MkDocs theme look a bit like MPG.

Requirements

• MkDocs
• Material for MkDocs theme

Usage

• Setup MkDocs and Material for MkDocs theme

• Install this plugin:

  pip install mkdocs-mpgtheme-plugin
  

• Activate this plugin in your MkDocs project:

  plugins:
   - mpgtheme
  theme:
   name: material
   logo: _assets/header-logo.svg
   footer_logo: _assets/footer-logo.svg
  extra:
   # all `extra`s are optional
   support_email: [e-mail]
   support_phone: [phone]
   privacy_policy_url: https://example.org/privacy-policy/
   imprint_url: https://example.org/imprint/
   copyright_string: ACME Inc.
  

• Save and reference your header and footer logo files.
  Due to licensing and copyright issues, the logo files are not part of this project, but we ship placeholder files for header-logo.svg and footer-logo.svg. Just set your logos (format: SVG) via logo and footer_logo in the themeconfig (see above).

• Done