Created "Build with Material for MkDocs" badges for README.md files and alike #6380
Andre601
started this conversation in
Show and tell
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Used the
devins-badges
template to make some badges that can be displayed in you readme file or other markdown files for that matter, to show that your docs were built using Material for MkDocs.It uses the icon available through Simple Icons.
Previews
Compact (Minimal)
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/compact-minimal/built-with/mkdocs-material_46h.png
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/compact-minimal/built-with/mkdocs-material_vector.svg
Compact
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/compact/built-with/mkdocs-material_46h.png
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/compact/built-with/mkdocs-material_vector.svg
Cozy (Minimal)
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/cozy-minimal/built-with/mkdocs-material_64h.png
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/cozy-minimal/built-with/mkdocs-material_vector.svg
Cozy
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/cozy/built-with/mkdocs-material_46h.png
https://cdn.jsdelivr.net/gh/Andre601/[email protected]/assets/cozy/built-with/mkdocs-material_vector.svg
Example Showcase
How it can look in a README.md file (I used it together with the "Built with MkDocs" badge)
Source of the shown README
Beta Was this translation helpful? Give feedback.
All reactions