Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 1 month 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
- Created: 2024-11-14T17:12:02.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-14T18:52:35.000Z (about 1 month ago)
- Last Synced: 2024-11-14T18:55:04.657Z (about 1 month ago)
- Topics: mkdocs, mkdocs-material, mkdocs-plugin
- Language: HTML
- Homepage: https://tombreit.github.io/mkdocs-mpgtheme-plugin/
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSES/MIT.txt
Awesome Lists containing this project
README
# MkDocs Material MPG Theme
A MkDocs plugin that makes the Material for MkDocs theme look a bit like MPG.
## Requirements
- [MkDocs](https://www.mkdocs.org/getting-started/)
- [Material for MkDocs theme](https://squidfunk.github.io/mkdocs-material/getting-started/)
## Usage
- Setup MkDocs and Material for MkDocs theme
- Install this plugin:
```bash
pip install mkdocs-mpgtheme-plugin
```
- Activate this plugin in your MkDocs project:
```yml
plugins:
- mpgtheme
theme:
name: material
logo: _assets/header-logo.svg
footer_logo: _assets/footer-logo.svg
extra:
# all `extra`s are optional
support_email: [email protected]
support_phone: +49 123 456 789
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.
- Done