Skip to content

Commit 8771cef

Browse files
committed
Updated README
Signed-off-by: squidfunk <[email protected]>
1 parent 7c9a1cc commit 8771cef

1 file changed

Lines changed: 38 additions & 280 deletions

File tree

‎README.md‎

Lines changed: 38 additions & 280 deletions
Original file line numberDiff line numberDiff line change
@@ -38,206 +38,35 @@
3838

3939
<p align="center">
4040
<a href="https://squidfunk.github.io/mkdocs-material/getting-started/">
41-
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" />
41+
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" alt="Material for MkDocs documentation site" />
4242
</a>
4343
</p>
4444

45-
<p align="center">
46-
<em>
47-
Check out the demo –
48-
<a
49-
href="https://squidfunk.github.io/mkdocs-material/"
50-
>squidfunk.github.io/mkdocs-material</a>.
51-
</em>
52-
</p>
53-
54-
<h2></h2>
55-
<p id="premium-sponsors">&nbsp;</p>
56-
<p align="center"><strong>Silver sponsors</strong></p>
57-
<p align="center">
58-
<a href="https://fastapi.tiangolo.com/" target=_blank><img
59-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png" height="120"
60-
/></a>
61-
<a href="https://www.trendpop.com/" target=_blank><img
62-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png" height="120"
63-
/></a>
64-
<a href="https://documentation.sailpoint.com/" target=_blank><img
65-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png" height="120"
66-
/></a>
67-
<a href="https://futureplc.com/" target=_blank><img
68-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-future.svg" width="332" height="120"
69-
/></a>
70-
<a href="https://opensource.siemens.com/" target=_blank><img
71-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-siemens.png" height="120"
72-
/></a>
73-
</p>
74-
<p>&nbsp;</p>
75-
<p align="center"><strong>Bronze sponsors</strong></p>
76-
<p align="center">
77-
<a href="https://cirrus-ci.org/" target=_blank><img
78-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png" height="58"
79-
/></a>
80-
<a href="https://docs.baslerweb.com/" target=_blank><img
81-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png" height="58"
82-
/></a>
83-
<a href="https://kx.com/" target=_blank><img
84-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png" height="58"
85-
/></a>
86-
<a href="https://orion-docs.prefect.io/" target=_blank><img
87-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png" height="58"
88-
/></a>
89-
<a href="https://www.zenoss.com/" target=_blank><img
90-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png" height="58"
91-
/></a>
92-
<a href="https://docs.posit.co" target=_blank><img
93-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png" height="58"
94-
/></a>
95-
<a href="https://n8n.io" target=_blank><img
96-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png" height="58"
97-
/></a>
98-
<a href="https://www.dogado.de" target=_blank><img
99-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-dogado.png" height="58"
100-
/></a>
101-
<a href="https://wwt.com" target=_blank><img
102-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-wwt.png" height="58"
103-
/></a>
104-
<a href="https://elastic.co" target=_blank><img
105-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png" height="58"
106-
/></a>
107-
<a href="https://ipfabric.io/" target=_blank><img
108-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png" height="58"
109-
/></a>
110-
<a href="https://www.apex.ai/" target=_blank><img
111-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png" height="58"
112-
/></a>
113-
<a href="https://jitterbit.com/" target=_blank><img
114-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png" height="58"
115-
/></a>
116-
<a href="https://sparkfun.com/" target=_blank><img
117-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png" height="58"
118-
/></a>
119-
<a href="https://eccenca.com/" target=_blank><img
120-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png" height="58"
121-
/></a>
122-
<a href="https://neptune.ai/" target=_blank><img
123-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png" height="58"
124-
/></a>
125-
<a href="https://rackn.com/" target=_blank><img
126-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png" height="58"
127-
/></a>
128-
<a href="https://civicactions.com/" target=_blank><img
129-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png" height="58"
130-
/></a>
131-
<a href="https://getscreen.me/" target=_blank><img
132-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png" height="58"
133-
/></a>
134-
<a href="https://botcity.dev/" target=_blank><img
135-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png" height="58"
136-
/></a>
137-
<a href="https://kolena.io/" target=_blank><img
138-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kolena.png" height="58"
139-
/></a>
140-
<a href="https://www.evergiving.com/" target=_blank><img
141-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-evergiving.png" height="58"
142-
/></a>
143-
<a href="https://astral.sh/" target=_blank><img
144-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png" height="58"
145-
/></a>
146-
<a href="https://oikolab.com/" target=_blank><img
147-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png" height="58"
148-
/></a>
149-
<a href="https://www.buhlergroup.com/" target=_blank><img
150-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png" height="58"
151-
/></a>
152-
<a href="https://3dr.com/" target=_blank><img
153-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png" height="58"
154-
/></a>
155-
<a href="https://spotware.com/" target=_blank><img
156-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png" height="58"
157-
/></a>
158-
<a href="https://milfordasset.com/" target=_blank><img
159-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png" height="58"
160-
/></a>
161-
<a href="https://www.lechler.com/" target=_blank><img
162-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png" height="58"
163-
/></a>
164-
<a href="https://invers.com/" target=_blank><img
165-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png" height="58"
166-
/></a>
167-
<a href="https://vantor.com/" target=_blank><img
168-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-vantor.png" height="58"
169-
/></a>
170-
<a href="https://www.equipmentshare.com/" target=_blank><img
171-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png" height="58"
172-
/></a>
173-
<a href="https://hummingbot.org/" target=_blank><img
174-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png" height="58"
175-
/></a>
176-
<a href="https://octoperf.com/" target=_blank><img
177-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-octoperf.png" height="58"
178-
/></a>
179-
<a href="https://intercomestibles.ch/" target=_blank><img
180-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-intercomestibles.png" height="58"
181-
/></a>
182-
<a href="https://www.centara.com/" target=_blank><img
183-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-centara.png" height="58"
184-
/></a>
185-
<a href="https://pydantic.dev/logfire/" target=_blank><img
186-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-logfire.png" height="58"
187-
/></a>
188-
<a href="https://www.vector.com/" target=_blank><img
189-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-vector.png" height="58"
190-
/></a>
191-
<a href="https://second.tech/" target=_blank><img
192-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-second.png" height="58"
193-
/></a>
194-
<a href="https://mvtec.com/" target=_blank><img
195-
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-mvtec.png" height="58"
196-
/></a>
197-
</p>
198-
<p>&nbsp;</p>
199-
200-
## Everything you would expect
201-
202-
### It's just Markdown
203-
204-
Focus on the content of your documentation and create a professional static site
205-
in minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs do
206-
the heavy lifting for you.
207-
208-
### Works on all devices
209-
210-
Serve your documentation with confidence – Material for MkDocs automatically
211-
adapts to perfectly fit the available screen estate, no matter the type or size
212-
of the viewing device. Desktop. Tablet. Mobile. All great.
213-
214-
### Made to measure
215-
216-
Make it yours – change the colors, fonts, language, icons, logo, and more with
217-
a few lines of configuration. Material for MkDocs can be easily extended and
218-
provides many options to alter appearance and behavior.
219-
220-
### Fast and lightweight
221-
222-
Don't let your users wait – get incredible value with a small footprint by using
223-
one of the fastest themes available with excellent performance, yielding optimal
224-
search engine rankings and happy users that return.
225-
226-
### Maintain ownership
227-
228-
Own your documentation's complete sources and outputs, guaranteeing both
229-
integrity and security – no need to entrust the backbone of your product
230-
knowledge to third-party platforms. Retain full control.
231-
232-
### Open Source
233-
234-
You're in good company – choose a mature and actively maintained solution built
235-
with state-of-the-art Open Source technologies, trusted by more than 50,000
236-
individuals and organizations. Licensed under MIT.
45+
---
46+
47+
> [!WARNING]
48+
>
49+
> **Material for MkDocs reaches end of life on May 5, 2027.** Critical fixes and
50+
> security updates continue until that date.
51+
>
52+
> We're continuing our work with [Zensical](https://zensical.org/), a
53+
> maintained successor built by the team behind Material for MkDocs. It carries
54+
> forward what we've learned from building documentation tools with this
55+
> community, with Markdown authoring, a familiar design, and full control over
56+
> your content. Zensical is Open Source and MIT-licensed.
57+
>
58+
> You can evaluate Zensical alongside MkDocs using your existing `mkdocs.yml`.
59+
> Check plugin compatibility and compare your pages, navigation, search, and
60+
> customizations before switching. The `classic` theme variant preserves the
61+
> appearance of Material for MkDocs. See the
62+
> [migration guide](https://zensical.org/docs/compatibility/mkdocs/migration/)
63+
> for the steps and current compatibility details.
64+
>
65+
> [Upcoming changes on November 5](https://zensical.org/upcoming-changes/)
23766
23867
## Quick start
23968

240-
Material for MkDocs can be installed with `pip`:
69+
Material for MkDocs requires Python 3.11 or newer. Install it with `pip`:
24170

24271
``` sh
24372
pip install mkdocs-material
@@ -250,97 +79,26 @@ theme:
25079
name: material
25180
```
25281
253-
For detailed installation instructions, configuration options, and a demo, visit
254-
[squidfunk.github.io/mkdocs-material][Material for MkDocs]
255-
256-
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
257-
258-
## Trusted by ...
259-
260-
### ... industry leaders
261-
262-
[ArXiv](https://info.arxiv.org),
263-
[Atlassian](https://atlassian.github.io/data-center-helm-charts/),
264-
[AWS](https://aws.github.io/copilot-cli/),
265-
[Bloomberg](https://bloomberg.github.io/selekt/),
266-
[CERN](http://abpcomputing.web.cern.ch/),
267-
[Datadog](https://datadoghq.dev/integrations-core/),
268-
[Google](https://google.github.io/accompanist/),
269-
[Harvard](https://informatics.fas.harvard.edu/),
270-
[Hewlett Packard](https://hewlettpackard.github.io/squest/),
271-
[HSBC](https://hsbc.github.io/pyratings/),
272-
[ING](https://ing-bank.github.io/baker/),
273-
[Intel](https://device-management-toolkit.github.io/docs/),
274-
[JetBrains](https://jetbrains.github.io/projector-client/mkdocs/),
275-
[LinkedIn](https://linkedin.github.io/school-of-sre/),
276-
[Microsoft](https://microsoft.github.io/code-with-engineering-playbook/),
277-
[Mozilla](https://mozillafoundation.github.io/engineering-handbook/),
278-
[Netflix](https://netflix.github.io/titus/),
279-
[OpenAI](https://openai.github.io/openai-agents-python/),
280-
[Red Hat](https://ansible.readthedocs.io/projects/lint/),
281-
[Roboflow](https://inference.roboflow.com/),
282-
[Salesforce](https://policy-sentry.readthedocs.io/),
283-
[SIEMENS](https://opensource.siemens.com/),
284-
[Slack](https://slackhq.github.io/circuit/),
285-
[Square](https://lysine.dev/okhttp/),
286-
[Uber](https://uber-go.github.io/fx/),
287-
[Zalando](https://opensource.zalando.com/skipper/)
82+
See the [installation guide](https://squidfunk.github.io/mkdocs-material/getting-started/)
83+
for detailed instructions and the
84+
[documentation](https://squidfunk.github.io/mkdocs-material/)
85+
for configuration options.
28886
289-
### ... and successful Open Source projects
87+
## Used by
29088
291-
[Amp](https://amp.rs/docs/),
292-
[Apache Iceberg](https://iceberg.apache.org/),
293-
[Arduino](https://arduino.github.io/arduino-cli/),
294-
[Asahi Linux](https://asahilinux.org/docs/),
295-
[Auto-GPT](https://docs.agpt.co/),
296-
[AutoKeras](https://autokeras.com/),
297-
[BFE](https://www.bfe-networks.net/),
298-
[CentOS](https://docs.infra.centos.org/),
299-
[Crystal](https://crystal-lang.org/reference/),
300-
[eBPF](https://ebpf-go.dev/),
301-
[ejabberd](https://docs.ejabberd.im/),
302-
[Electron](https://www.electron.build/),
89+
Material for MkDocs has been used by projects including
30390
[FastAPI](https://fastapi.tiangolo.com/),
304-
[FlatBuffers](https://flatbuffers.dev/),
305-
[{fmt}](https://fmt.dev/),
306-
[Freqtrade](https://www.freqtrade.io/en/stable/),
307-
[GoReleaser](https://goreleaser.com/),
308-
[GraphRAG](https://microsoft.github.io/graphrag/),
309-
[Headscale](https://headscale.net/),
310-
[HedgeDoc](https://docs.hedgedoc.org/),
311-
[Hummingbot](https://hummingbot.org/),
312-
[Knative](https://knative.dev/docs/),
313-
[Kubernetes](https://kops.sigs.k8s.io/),
314-
[kSQL](https://docs.ksqldb.io/),
315-
[LeakCanary](https://square.github.io/leakcanary/),
316-
[LlamaIndex](https://docs.llamaindex.ai/),
317-
[NetBox](https://netboxlabs.com/docs/netbox/en/stable/),
318-
[Nokogiri](https://nokogiri.org/),
319-
[OpenAI](https://openai.github.io/openai-agents-python/),
320-
[OpenFaaS](https://docs.openfaas.com/),
321-
[OpenSSL](https://docs.openssl.org/),
322-
[Orchard Core](https://docs.orchardcore.net/en/latest/),
323-
[Percona](https://docs.percona.com/percona-monitoring-and-management/),
324-
[Pi-Hole](https://docs.pi-hole.net/),
325-
[Polars](https://docs.pola.rs/),
32691
[Pydantic](https://pydantic-docs.helpmanual.io/),
327-
[PyPI](https://docs.pypi.org/),
328-
[Quivr](https://core.quivr.com/),
329-
[Renovate](https://docs.renovatebot.com/),
330-
[RetroPie](https://retropie.org.uk/docs/),
33192
[Ruff](https://docs.astral.sh/ruff/),
332-
[Supervision](https://supervision.roboflow.com/latest/),
333-
[Textual](https://textual.textualize.io/),
334-
[Traefik](https://docs.traefik.io/),
335-
[Trivy](https://aquasecurity.github.io/trivy/),
336-
[Typer](https://typer.tiangolo.com/),
337-
[tinygrad](https://docs.tinygrad.org/),
338-
[Ultralytics](https://docs.ultralytics.com/),
339-
[UV](https://docs.astral.sh/uv/),
340-
[Vapor](https://docs.vapor.codes/),
341-
[WebKit](https://docs.webkit.org/),
342-
[WTF](https://wtfutil.com/),
343-
[ZeroNet](https://zeronet.io/docs/)
93+
[OpenSSL](https://docs.openssl.org/),
94+
[AWS Copilot](https://aws.github.io/copilot-cli/), and
95+
[Google Accompanist](https://google.github.io/accompanist/).
96+
97+
## Acknowledgments
98+
99+
Thank you to everyone who sponsored Material for MkDocs. Your support made its
100+
development possible. We're grateful to the contributors, translators, and
101+
users who helped shape the project over the years.
344102
345103
## License
346104

0 commit comments

Comments
 (0)