2022-04-02 13:22:14 +02:00
|
|
|
|
# Philosophy
|
2022-04-01 19:01:13 +02:00
|
|
|
|
|
2022-04-02 13:22:14 +02:00
|
|
|
|
Before settling for Material for MkDocs, it's a good idea to understand the
|
|
|
|
|
philosophy behind the project, in order to make sure it aligns with your goals.
|
|
|
|
|
This page explains the design principles anchored in Material for MkDocs, and
|
|
|
|
|
discusses the [conventions] used in this documentation.
|
|
|
|
|
|
2024-04-25 05:51:05 +02:00
|
|
|
|
[conventions]: conventions.md
|
2022-04-02 13:22:14 +02:00
|
|
|
|
|
|
|
|
|
## Design principles
|
|
|
|
|
|
|
|
|
|
- __It's just Markdown__: Focus on the content of your documentation and create
|
|
|
|
|
a professional static site in minutes. No need to know HTML,CSS or JavaScript
|
|
|
|
|
– let Material for MkDocs do the heavy lifting for you.
|
|
|
|
|
|
2023-09-14 19:09:18 +02:00
|
|
|
|
- __Works on all devices__: Serve your documentation with confidence – the
|
|
|
|
|
underlying layout automatically adapts to perfectly fit the available screen
|
2022-04-02 13:22:14 +02:00
|
|
|
|
estate, no matter the type or size of the viewing device.
|
|
|
|
|
|
|
|
|
|
- __Made to measure__: Change the colors, fonts, language, icons, logo and much
|
2023-09-14 19:09:18 +02:00
|
|
|
|
more with a few lines of configuration. Material for MkDocs can be easily
|
2022-04-02 13:22:14 +02:00
|
|
|
|
extended and provides tons of options to alter appearance and behavior.
|
|
|
|
|
|
|
|
|
|
- __Fast and lightweight__: Don't let your users wait – get incredible value
|
|
|
|
|
with a small footprint, by using one of the fastest themes around with
|
|
|
|
|
excellent performance, yielding great search engine rankings and happy
|
|
|
|
|
users that return.
|
|
|
|
|
|
|
|
|
|
- __Accessible__: Make accessibility a priority – users can navigate your
|
|
|
|
|
documentation with touch devices, keyboard, and screen readers. Semantic
|
|
|
|
|
markup ensures that your documentation works for everyone.
|
|
|
|
|
|
2022-11-12 14:47:36 +01:00
|
|
|
|
- __Open Source__: Trust 20,000+ users – choose a mature and well-funded
|
2022-04-02 13:22:14 +02:00
|
|
|
|
solution built with state-of-the-art Open Source technologies. Keep ownership
|
|
|
|
|
of your content without fear of vendor lock-in. Licensed under MIT.
|