pawelsikora / mkdocs-git-show-history-log-plugin

MkDocs plugin for showing a history log for a specified markdown file
MIT License
3 stars 2 forks source link

Suggestion: use Admonitions features from Mkdocs Material #3

Open julienbeisel opened 2 years ago

julienbeisel commented 2 years ago

It is just a suggestion so feel free to close the issue if you don't like the idea.

I use it for a company website and we have to make it beautiful for everyone. I decided to use Admonitions for that : https://squidfunk.github.io/mkdocs-material/reference/admonitions/

Here is how it looks like at the top of our document (in french):

image

image

That's how I use this plugin, so maybe other people will like the way it looks. Idk if it can be configured or not :)

pawelsikora commented 2 years ago

@julienbeisel Actually I am using it too, but for other purposes in my markdown files.

Reasons why I did not use it here are simple:

  1. I needed just the basic format of changelog and did not play with a layout so much

Honestly, it did worked for me and it was not developed since more than one year because it just worked as expected.

But on the contrary: i think it is a good idea to add it, with some parameter option, as we need to cover the case when someone is not using that plugin. Parameter or not, it should be able to handle it. Will look at it tomorrow.