Skip to content

Commit

Permalink
Mention PyPI package, misc
Browse files Browse the repository at this point in the history
  • Loading branch information
tombreit committed Dec 30, 2024
1 parent 1fddb08 commit 2e579ab
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@ This plugin uses the "Material for MkDocs" theme and just adds some visual touch

<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:
- Install this plugin from [PyPI](https://pypi.org/project/mkdocs-mpgtheme-plugin/):

```bash
pip install mkdocs-mpgtheme-plugin
Expand Down
17 changes: 14 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# Home
# MkDocs MPG Theme

Aenean non orci a urna dictum lacinia. Pellentesque rutrum sem a massa ultricies, sed rhoncus eros aliquam. Etiam tempor enim ac tristique tincidunt. Etiam tristique tempor magna ut laoreet.
MkDocs plugin to add some MPG branding to the Material for MkDocs theme.

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

## Project

- [Repository](https://github.com/tombreit/mkdocs-mpgtheme-plugin)
- [PyPI](https://pypi.org/project/mkdocs-mpgtheme-plugin/)

## Credits

- [MkDocs](https://www.mkdocs.org/)
- [MkDocs Material Theme](https://squidfunk.github.io/mkdocs-material/)
- [MkDocs MPG Theme](https://tombreit.github.io/mkdocs-mpgtheme-plugin/)

Maecenas et enim ac dui pharetra blandit. Ut eu nisl non mi tempus molestie at quis libero. Sed est ipsum, sodales eget turpis sed, ullamcorper aliquet ipsum. Cras non dui et lorem lacinia pellentesque non at nisi. In bibendum sed mauris dignissim rhoncus. Aliquam hendrerit sapien est, a tristique libero mollis et. Nulla nec bibendum libero, eget congue purus.
## Notes

- Installing this plugin will install `mkdocs` and `mkdocs-material` as dependencies.
- For a more complete configuration, see our demo [`mkdocs.yml`](https://github.com/tombreit/mkdocs-mpgtheme-plugin/blob/main/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).

0 comments on commit 2e579ab

Please sign in to comment.