mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2025-01-11 05:32:14 +01:00
Documentation (#7816)
* docs(philosophy): Update trusted by users count * docs(philosophy): adopt text from readme * docs(blog tutorial): Fix line highlighting in code block * docs(philosophy): Change trust user count to 50,000+ * docs(philosophy): adopt text from readme
This commit is contained in:
parent
1f78e37dda
commit
51e4d4b212
@ -9,27 +9,16 @@ discusses the [conventions] used in this documentation.
|
|||||||
|
|
||||||
## Design principles
|
## Design principles
|
||||||
|
|
||||||
- __It's just Markdown__: Focus on the content of your documentation and create
|
- **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.
|
||||||
a professional static site in minutes. No need to know HTML,CSS or JavaScript
|
|
||||||
– let Material for MkDocs do the heavy lifting for you.
|
|
||||||
|
|
||||||
- __Works on all devices__: Serve your documentation with confidence – the
|
- **Works on all devices**: Serve your documentation with confidence – Material for MkDocs automatically adapts to perfectly fit the available screen estate, no matter the type or size of the viewing device. Desktop. Tablet. Mobile. All great.
|
||||||
underlying layout automatically adapts to perfectly fit the available screen
|
|
||||||
estate, no matter the type or size of the viewing device.
|
|
||||||
|
|
||||||
- __Made to measure__: Change the colors, fonts, language, icons, logo and much
|
- **Made to measure**: Make it yours – change the colors, fonts, language, icons, logo, and more with a few lines of configuration. Material for MkDocs can be easily extended and provides many options to alter appearance and behavior.
|
||||||
more with a few lines of configuration. Material for MkDocs can be easily
|
|
||||||
extended and provides tons of options to alter appearance and behavior.
|
|
||||||
|
|
||||||
- __Fast and lightweight__: Don't let your users wait – get incredible value
|
- **Fast and lightweight**: Don't let your users wait – get incredible value with a small footprint by using one of the fastest themes available with excellent performance, yielding optimal search engine rankings and happy users that return.
|
||||||
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
|
- **Maintain ownership**: Make accessibility a priority – users can navigate your
|
||||||
documentation with touch devices, keyboard, and screen readers. Semantic
|
documentation with touch devices, keyboard, and screen readers. Semantic
|
||||||
markup ensures that your documentation works for everyone.
|
markup ensures that your documentation works for everyone.
|
||||||
|
|
||||||
- __Open Source__: Trust 45,000+ users – choose a mature and well-funded
|
- **Open Source**: You're in good company – choose a mature and actively maintained solution built with state-of-the-art Open Source technologies, trusted by more than 50.000 individuals and organizations. Licensed under MIT.
|
||||||
solution built with state-of-the-art Open Source technologies. Keep ownership
|
|
||||||
of your content without fear of vendor lock-in. Licensed under MIT.
|
|
||||||
|
@ -240,7 +240,7 @@ attribute in the page header:
|
|||||||
|
|
||||||
Add the `pin` attribute to your first blog post:
|
Add the `pin` attribute to your first blog post:
|
||||||
|
|
||||||
```hl_lines="5"
|
```hl_lines="6"
|
||||||
---
|
---
|
||||||
date:
|
date:
|
||||||
created: 2023-12-31
|
created: 2023-12-31
|
||||||
|
Loading…
x
Reference in New Issue
Block a user