Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suggestion: use Admonitions features from Mkdocs Material #3

Open
julienbeisel opened this issue Jan 13, 2022 · 1 comment
Open

Suggestion: use Admonitions features from Mkdocs Material #3

julienbeisel opened this issue Jan 13, 2022 · 1 comment

Comments

@julienbeisel
Copy link

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
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants