https://github.com/tombreit/mkdocs-mpgtheme-plugin
A MkDocs plugin that makes the Material for MkDocs theme look a bit more like MPG.
https://github.com/tombreit/mkdocs-mpgtheme-plugin
mkdocs mkdocs-material mkdocs-plugin
Last synced: 7 months ago
JSON representation
A MkDocs plugin that makes the Material for MkDocs theme look a bit more like MPG.
- Host: GitHub
- URL: https://github.com/tombreit/mkdocs-mpgtheme-plugin
- Owner: tombreit
- License: mit
- Created: 2024-11-14T17:12:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-19T09:05:54.000Z (12 months ago)
- Last Synced: 2025-06-13T03:47:51.264Z (8 months ago)
- Topics: mkdocs, mkdocs-material, mkdocs-plugin
- Language: HTML
- Homepage: https://tombreit.github.io/mkdocs-mpgtheme-plugin/
- Size: 648 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
## PyPI Package
## 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).