Metadata-Version: 2.1
Name: mkdocs-mpgtheme-plugin
Version: 2024.12.8
Summary: MkDocs plugin to add some MPG branding to the Material for MkDocs theme
Author-email: Thomas Breitner <mail@thms.de>
License: MIT License
        
        Copyright (c) <year> <copyright holders>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Repository, https://github.com/tombreit/mkdocs-mpgtheme-plugin
Project-URL: Homepage, https://github.com/tombreit/mkdocs-mpgtheme-plugin
Project-URL: Documentation, https://github.com/tombreit/mkdocs-mpgtheme-plugin/blob/main/README.md
Project-URL: Issues, https://github.com/tombreit/mkdocs-mpgtheme-plugin/issues
Classifier: Framework :: MkDocs
Classifier: Topic :: Documentation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: mkdocs>=1.6
Requires-Dist: mkdocs-material>=9.0.0
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: reuse; extra == "dev"
Provides-Extra: pypi
Requires-Dist: build; extra == "pypi"
Requires-Dist: twine; extra == "pypi"

# MkDocs MPG Theme

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

This plugin uses the "Material for MkDocs" theme and just adds some visual touches.

## Requirements

- [MkDocs](https://www.mkdocs.org/getting-started/)
- [Material for MkDocs theme](https://squidfunk.github.io/mkdocs-material/getting-started/)

## Demo

<https://tombreit.github.io/mkdocs-mpgtheme-plugin/>

## PyPI Package

<https://pypi.org/project/mkdocs-mpgtheme-plugin/>

## Usage

- Setup MkDocs and Material for MkDocs theme
- Install this plugin from [PyPI](https://pypi.org/project/mkdocs-mpgtheme-plugin/):

   ```bash
   pip install mkdocs-mpgtheme-plugin
   ```

- Activate and configure this plugin in your MkDocs project:

   ```yml
   # file: mkdocs.yml

   plugins:
     - search
     - mpgtheme
   theme:
     name: material
     logo: _assets/header-logo.svg
     footer_logo: _assets/footer-logo.svg
  extra:
     # all extras are optional
     support_email: mail@example.org
     support_phone: +49 123 456 789
     privacy_policy_url: https://example.org/privacy
     imprint_url: https://example.org/imprint
     copyright_string: ACME Inc.
   ```

- Save and reference your header and footer logo files.
- That's it.

## Notes

- Installing this plugin will install `mkdocs` and `mkdocs-material` as dependencies.
- For a more complete configuration, see our demo [`mkdocs.yml`](./mkdocs.yml).
- Due to licensing and copyright issues, the MPG 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 `theme` config (see above).
