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 days 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 (2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-30T10:14:21.000Z (23 days ago)
• Last Synced: 2024-12-30T10:31:47.965Z (23 days ago)
• Topics: mkdocs, mkdocs-material, mkdocs-plugin
• Language: HTML
• Homepage: https://tombreit.github.io/mkdocs-mpgtheme-plugin/
• Size: 642 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• 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: [email protected]

     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).