| Name | mkdocs-material JSON |
| Version |
9.5.44
JSON |
| download |
| home_page | None |
| Summary | Documentation that simply works |
| upload_time | 2024-11-05 18:23:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
documentation
mkdocs
theme
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg" width="320" alt="Material for MkDocs">
</a>
</p>
<p align="center">
<strong>
A powerful documentation framework on top of
<a href="https://www.mkdocs.org/">MkDocs</a>
</strong>
</p>
<p align="center">
<a href="https://github.com/squidfunk/mkdocs-material/actions"><img
src="https://github.com/squidfunk/mkdocs-material/workflows/build/badge.svg?branch=master"
alt="Build"
/></a>
<a href="https://pypistats.org/packages/mkdocs-material"><img
src="https://img.shields.io/pypi/dm/mkdocs-material.svg"
alt="Downloads"
/></a>
<a href="https://pypi.org/project/mkdocs-material"><img
src="https://img.shields.io/pypi/v/mkdocs-material.svg"
alt="Python Package Index"
/></a>
<a href="https://hub.docker.com/r/squidfunk/mkdocs-material/"><img
src="https://img.shields.io/docker/pulls/squidfunk/mkdocs-material"
alt="Docker Pulls"
/></a>
<a href="https://github.com/sponsors/squidfunk"><img
src="https://img.shields.io/github/sponsors/squidfunk"
alt="Sponsors"
/></a>
</p>
<p align="center">
Write your documentation in Markdown and create a professional static site for
your Open Source or commercial project in minutes – searchable, customizable,
more than 60 languages, for all devices.
</p>
<p align="center">
<a href="https://squidfunk.github.io/mkdocs-material/getting-started/">
<img src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png" width="700" />
</a>
</p>
<p align="center">
<em>
Check out the demo –
<a
href="https://squidfunk.github.io/mkdocs-material/"
>squidfunk.github.io/mkdocs-material</a>.
</em>
</p>
<h2></h2>
<p id="premium-sponsors"> </p>
<p align="center"><strong>Silver sponsors</strong></p>
<p align="center">
<a href="https://fastapi.tiangolo.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png" height="120"
/></a>
<a href="https://www.trendpop.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png" height="120"
/></a>
<a href="https://documentation.sailpoint.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png" height="120"
/></a>
<a href="https://futureplc.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-future.svg" height="120"
/></a>
<a href="https://opensource.siemens.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-siemens.png" height="120"
/></a>
</p>
<p> </p>
<p align="center"><strong>Bronze sponsors</strong></p>
<p align="center">
<a href="https://cirrus-ci.org/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png" height="58"
/></a>
<a href="https://docs.baslerweb.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png" height="58"
/></a>
<a href="https://kx.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png" height="58"
/></a>
<a href="https://orion-docs.prefect.io/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png" height="58"
/></a>
<a href="https://www.zenoss.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png" height="58"
/></a>
<a href="https://docs.posit.co" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png" height="58"
/></a>
<a href="https://n8n.io" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png" height="58"
/></a>
<a href="https://www.dogado.de" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-dogado.png" height="58"
/></a>
<a href="https://wwt.com" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-wwt.png" height="58"
/></a>
<a href="https://coda.io" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-coda.png" height="58"
/></a>
<a href="https://elastic.co" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png" height="58"
/></a>
<a href="https://ipfabric.io/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png" height="58"
/></a>
<a href="https://www.apex.ai/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png" height="58"
/></a>
<a href="https://jitterbit.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png" height="58"
/></a>
<a href="https://sparkfun.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png" height="58"
/></a>
<a href="https://eccenca.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png" height="58"
/></a>
<a href="https://neptune.ai/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png" height="58"
/></a>
<!-- <a href="https://cash.app/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cashapp.png" height="58"
/></a> -->
<a href="https://rackn.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png" height="58"
/></a>
<a href="https://civicactions.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png" height="58"
/></a>
<a href="https://bitcrowd.net/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-bitcrowd.png" height="58"
/></a>
<a href="https://getscreen.me/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png" height="58"
/></a>
<a href="https://botcity.dev/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png" height="58"
/></a>
<a href="https://www.springernature.com/gp" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sn-technology.png" height="58"
/></a>
<a href="https://kolena.io/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kolena.png" height="58"
/></a>
<a href="https://www.evergiving.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-evergiving.png" height="58"
/></a>
<a href="https://koor.tech/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-koor.png" height="58"
/></a>
<a href="https://astral.sh/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png" height="58"
/></a>
<a href="https://oikolab.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png" height="58"
/></a>
<a href="https://www.buhlergroup.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png" height="58"
/></a>
<a href="https://3dr.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png" height="58"
/></a>
<a href="https://spotware.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png" height="58"
/></a>
<a href="https://milfordasset.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png" height="58"
/></a>
<a href="https://www.lechler.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png" height="58"
/></a>
<a href="https://invers.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png" height="58"
/></a>
<a href="https://maxar.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png" height="58"
/></a>
<a href="https://www.equipmentshare.com/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png" height="58"
/></a>
<a href="https://hummingbot.org/" target=_blank><img
src="https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png" height="58"
/></a>
</p>
<p> </p>
## Everything you would expect
### 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.
### 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.
### 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.
### 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.
### Built for everyone
Make accessibility a priority – users can navigate your documentation with touch
devices, keyboards, and screen readers. Semantic markup ensures that your
documentation works for everyone.
### Open Source
Trust 20,000+ users – choose a mature and actively maintained solution built
with state-of-the-art Open Source technologies. Keep ownership of your content
without fear of vendor lock-in. Licensed under MIT.
## Quick start
Material for MkDocs can be installed with `pip`:
``` sh
pip install mkdocs-material
```
Add the following lines to `mkdocs.yml`:
``` yaml
theme:
name: material
```
For detailed installation instructions, configuration options, and a demo, visit
[squidfunk.github.io/mkdocs-material][Material for MkDocs]
[Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/
## Trusted by ...
### ... industry leaders
[ArXiv](https://info.arxiv.org),
[Atlassian](https://atlassian.github.io/data-center-helm-charts/),
[AWS](https://aws.github.io/copilot-cli/),
[Bloomberg](https://bloomberg.github.io/selekt/),
[CERN](http://abpcomputing.web.cern.ch/),
[CloudFlare](https://cloudflare.github.io/itty-router-openapi/),
[Datadog](https://datadoghq.dev/integrations-core/),
[Google](https://google.github.io/accompanist/),
[Harvard](https://informatics.fas.harvard.edu/),
[Hewlett Packard](https://hewlettpackard.github.io/squest/),
[HSBC](https://hsbc.github.io/pyratings/),
[ING](https://ing-bank.github.io/baker/),
[Intel](https://open-amt-cloud-toolkit.github.io/docs/),
[JetBrains](https://jetbrains.github.io/projector-client/mkdocs/),
[LinkedIn](https://linkedin.github.io/school-of-sre/),
[Microsoft](https://microsoft.github.io/code-with-engineering-playbook/),
[Mozilla](https://mozillafoundation.github.io/engineering-handbook/),
[Netflix](https://netflix.github.io/titus/),
[Red Hat](https://ansible.readthedocs.io/projects/lint/),
[Roboflow](https://inference.roboflow.com/),
[Salesforce](https://policy-sentry.readthedocs.io/),
[SIEMENS](https://opensource.siemens.com/),
[Slack](https://slackhq.github.io/circuit/),
[Square](https://square.github.io/okhttp/),
[Uber](https://uber-go.github.io/fx/),
[Zalando](https://opensource.zalando.com/skipper/)
### ... and successful Open Source projects
[Amp](https://amp.rs/docs/),
[Arduino](https://arduino.github.io/arduino-cli/),
[Auto-GPT](https://docs.agpt.co/),
[AutoKeras](https://autokeras.com/),
[BFE](https://www.bfe-networks.net/),
[CentOS](https://docs.infra.centos.org/),
[Crystal](https://crystal-lang.org/reference/),
[eBPF](https://ebpf-go.dev/),
[Electron](https://www.electron.build/),
[FastAPI](https://fastapi.tiangolo.com/),
[Freqtrade](https://www.freqtrade.io/en/stable/),
[GoReleaser](https://goreleaser.com/),
[HedgeDoc](https://docs.hedgedoc.org/),
[Hummingbot](https://hummingbot.org/),
[Knative](https://knative.dev/docs/),
[Kubernetes](https://kops.sigs.k8s.io/),
[kSQL](https://docs.ksqldb.io/),
[NetBox](https://netboxlabs.com/docs/netbox/en/stable/),
[Nokogiri](https://nokogiri.org/),
[OpenFaaS](https://docs.openfaas.com/),
[Orchard Core](https://docs.orchardcore.net/en/latest/),
[Percona](https://docs.percona.com/percona-monitoring-and-management/),
[Pi-Hole](https://docs.pi-hole.net/),
[Pydantic](https://pydantic-docs.helpmanual.io/),
[PyPI](https://docs.pypi.org/),
[Renovate](https://docs.renovatebot.com/),
[RetroPie](https://retropie.org.uk/docs/),
[Supervision](https://supervision.roboflow.com/latest/),
[Traefik](https://docs.traefik.io/),
[Trivy](https://aquasecurity.github.io/trivy/),
[Typer](https://typer.tiangolo.com/),
[tinygrad](https://docs.tinygrad.org/),
[Ultralytics](https://docs.ultralytics.com/),
[Vapor](https://docs.vapor.codes/),
[WebKit](https://docs.webkit.org/),
[WTF](https://wtfutil.com/),
[ZeroNet](https://zeronet.io/docs/)
## License
**MIT License**
Copyright (c) 2016-2024 Martin Donath
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-material",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "documentation, mkdocs, theme",
"author": null,
"author_email": "Martin Donath <martin.donath@squidfunk.com>",
"download_url": "https://files.pythonhosted.org/packages/f7/56/182d8121db9ab553cdf9bc58d5972b89833f60b63272f693c1f2b849b640/mkdocs_material-9.5.44.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://squidfunk.github.io/mkdocs-material/\">\n <img src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/logo.svg\" width=\"320\" alt=\"Material for MkDocs\">\n </a>\n</p>\n\n<p align=\"center\">\n <strong>\n A powerful documentation framework on top of\n <a href=\"https://www.mkdocs.org/\">MkDocs</a>\n </strong>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/squidfunk/mkdocs-material/actions\"><img\n src=\"https://github.com/squidfunk/mkdocs-material/workflows/build/badge.svg?branch=master\"\n alt=\"Build\"\n /></a>\n <a href=\"https://pypistats.org/packages/mkdocs-material\"><img\n src=\"https://img.shields.io/pypi/dm/mkdocs-material.svg\"\n alt=\"Downloads\"\n /></a>\n <a href=\"https://pypi.org/project/mkdocs-material\"><img\n src=\"https://img.shields.io/pypi/v/mkdocs-material.svg\"\n alt=\"Python Package Index\"\n /></a>\n <a href=\"https://hub.docker.com/r/squidfunk/mkdocs-material/\"><img\n src=\"https://img.shields.io/docker/pulls/squidfunk/mkdocs-material\"\n alt=\"Docker Pulls\"\n /></a>\n <a href=\"https://github.com/sponsors/squidfunk\"><img\n src=\"https://img.shields.io/github/sponsors/squidfunk\"\n alt=\"Sponsors\"\n /></a>\n</p>\n\n<p align=\"center\">\n Write your documentation in Markdown and create a professional static site for\n your Open Source or commercial project in minutes \u2013 searchable, customizable,\n more than 60 languages, for all devices.\n</p>\n\n<p align=\"center\">\n <a href=\"https://squidfunk.github.io/mkdocs-material/getting-started/\">\n <img src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/screenshot.png\" width=\"700\" />\n </a>\n</p>\n\n<p align=\"center\">\n <em>\n Check out the demo \u2013\n <a\n href=\"https://squidfunk.github.io/mkdocs-material/\"\n >squidfunk.github.io/mkdocs-material</a>.\n </em>\n</p>\n\n<h2></h2>\n<p id=\"premium-sponsors\"> </p>\n<p align=\"center\"><strong>Silver sponsors</strong></p>\n<p align=\"center\">\n <a href=\"https://fastapi.tiangolo.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-fastapi.png\" height=\"120\"\n /></a>\n <a href=\"https://www.trendpop.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-trendpop.png\" height=\"120\"\n /></a>\n <a href=\"https://documentation.sailpoint.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sailpoint.png\" height=\"120\"\n /></a>\n <a href=\"https://futureplc.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-future.svg\" height=\"120\"\n /></a>\n <a href=\"https://opensource.siemens.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-siemens.png\" height=\"120\"\n /></a>\n</p>\n<p> </p>\n<p align=\"center\"><strong>Bronze sponsors</strong></p>\n<p align=\"center\">\n <a href=\"https://cirrus-ci.org/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cirrus-ci.png\" height=\"58\"\n /></a>\n <a href=\"https://docs.baslerweb.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-basler.png\" height=\"58\"\n /></a>\n <a href=\"https://kx.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kx.png\" height=\"58\"\n /></a>\n <a href=\"https://orion-docs.prefect.io/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-prefect.png\" height=\"58\"\n /></a>\n <a href=\"https://www.zenoss.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-zenoss.png\" height=\"58\"\n /></a>\n <a href=\"https://docs.posit.co\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-posit.png\" height=\"58\"\n /></a>\n <a href=\"https://n8n.io\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-n8n.png\" height=\"58\"\n /></a>\n <a href=\"https://www.dogado.de\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-dogado.png\" height=\"58\"\n /></a>\n <a href=\"https://wwt.com\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-wwt.png\" height=\"58\"\n /></a>\n <a href=\"https://coda.io\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-coda.png\" height=\"58\"\n /></a>\n <a href=\"https://elastic.co\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-elastic.png\" height=\"58\"\n /></a>\n <a href=\"https://ipfabric.io/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-ip-fabric.png\" height=\"58\"\n /></a>\n <a href=\"https://www.apex.ai/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-apex-ai.png\" height=\"58\"\n /></a>\n <a href=\"https://jitterbit.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-jitterbit.png\" height=\"58\"\n /></a>\n <a href=\"https://sparkfun.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sparkfun.png\" height=\"58\"\n /></a>\n <a href=\"https://eccenca.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-eccenca.png\" height=\"58\"\n /></a>\n <a href=\"https://neptune.ai/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-neptune-ai.png\" height=\"58\"\n /></a>\n <!-- <a href=\"https://cash.app/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-cashapp.png\" height=\"58\"\n /></a> -->\n <a href=\"https://rackn.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-rackn.png\" height=\"58\"\n /></a>\n <a href=\"https://civicactions.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-civic-actions.png\" height=\"58\"\n /></a>\n <a href=\"https://bitcrowd.net/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-bitcrowd.png\" height=\"58\"\n /></a>\n <a href=\"https://getscreen.me/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-getscreenme.png\" height=\"58\"\n /></a>\n <a href=\"https://botcity.dev/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-botcity.png\" height=\"58\"\n /></a>\n <a href=\"https://www.springernature.com/gp\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-sn-technology.png\" height=\"58\"\n /></a>\n <a href=\"https://kolena.io/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-kolena.png\" height=\"58\"\n /></a>\n <a href=\"https://www.evergiving.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-evergiving.png\" height=\"58\"\n /></a>\n <a href=\"https://koor.tech/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-koor.png\" height=\"58\"\n /></a>\n <a href=\"https://astral.sh/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-astral.png\" height=\"58\"\n /></a>\n <a href=\"https://oikolab.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-oikolab.png\" height=\"58\"\n /></a>\n <a href=\"https://www.buhlergroup.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-buhler.png\" height=\"58\"\n /></a>\n <a href=\"https://3dr.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-3dr.png\" height=\"58\"\n /></a>\n <a href=\"https://spotware.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-spotware.png\" height=\"58\"\n /></a>\n <a href=\"https://milfordasset.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-milford.png\" height=\"58\"\n /></a>\n <a href=\"https://www.lechler.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-lechler.png\" height=\"58\"\n /></a>\n <a href=\"https://invers.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-invers.png\" height=\"58\"\n /></a>\n <a href=\"https://maxar.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-maxar.png\" height=\"58\"\n /></a>\n <a href=\"https://www.equipmentshare.com/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-equipmentshare.png\" height=\"58\"\n /></a>\n <a href=\"https://hummingbot.org/\" target=_blank><img\n src=\"https://raw.githubusercontent.com/squidfunk/mkdocs-material/master/.github/assets/sponsors/sponsor-hummingbot.png\" height=\"58\"\n /></a>\n</p>\n<p> </p>\n\n## Everything you would expect\n\n### It's just Markdown\n\nFocus on the content of your documentation and create a professional static site\nin minutes. No need to know HTML, CSS or JavaScript \u2013 let Material for MkDocs do\nthe heavy lifting for you.\n\n### Works on all devices\n\nServe your documentation with confidence \u2013 Material for MkDocs automatically\nadapts to perfectly fit the available screen estate, no matter the type or size\nof the viewing device. Desktop. Tablet. Mobile. All great.\n\n### Made to measure\n\nMake it yours \u2013 change the colors, fonts, language, icons, logo, and more with\na few lines of configuration. Material for MkDocs can be easily extended and\nprovides many options to alter appearance and behavior.\n\n### Fast and lightweight\n\nDon't let your users wait \u2013 get incredible value with a small footprint by using\none of the fastest themes available with excellent performance, yielding optimal\nsearch engine rankings and happy users that return.\n\n### Built for everyone\n\nMake accessibility a priority \u2013 users can navigate your documentation with touch\ndevices, keyboards, and screen readers. Semantic markup ensures that your\ndocumentation works for everyone.\n\n### Open Source\n\nTrust 20,000+ users \u2013 choose a mature and actively maintained solution built\nwith state-of-the-art Open Source technologies. Keep ownership of your content\nwithout fear of vendor lock-in. Licensed under MIT.\n\n## Quick start\n\nMaterial for MkDocs can be installed with `pip`:\n\n``` sh\npip install mkdocs-material\n```\n\nAdd the following lines to `mkdocs.yml`:\n\n``` yaml\ntheme:\n name: material\n```\n\nFor detailed installation instructions, configuration options, and a demo, visit\n[squidfunk.github.io/mkdocs-material][Material for MkDocs]\n\n [Material for MkDocs]: https://squidfunk.github.io/mkdocs-material/\n\n## Trusted by ...\n\n### ... industry leaders\n\n[ArXiv](https://info.arxiv.org),\n[Atlassian](https://atlassian.github.io/data-center-helm-charts/),\n[AWS](https://aws.github.io/copilot-cli/),\n[Bloomberg](https://bloomberg.github.io/selekt/),\n[CERN](http://abpcomputing.web.cern.ch/),\n[CloudFlare](https://cloudflare.github.io/itty-router-openapi/),\n[Datadog](https://datadoghq.dev/integrations-core/),\n[Google](https://google.github.io/accompanist/),\n[Harvard](https://informatics.fas.harvard.edu/),\n[Hewlett Packard](https://hewlettpackard.github.io/squest/),\n[HSBC](https://hsbc.github.io/pyratings/),\n[ING](https://ing-bank.github.io/baker/),\n[Intel](https://open-amt-cloud-toolkit.github.io/docs/),\n[JetBrains](https://jetbrains.github.io/projector-client/mkdocs/),\n[LinkedIn](https://linkedin.github.io/school-of-sre/),\n[Microsoft](https://microsoft.github.io/code-with-engineering-playbook/),\n[Mozilla](https://mozillafoundation.github.io/engineering-handbook/),\n[Netflix](https://netflix.github.io/titus/),\n[Red Hat](https://ansible.readthedocs.io/projects/lint/),\n[Roboflow](https://inference.roboflow.com/),\n[Salesforce](https://policy-sentry.readthedocs.io/),\n[SIEMENS](https://opensource.siemens.com/),\n[Slack](https://slackhq.github.io/circuit/),\n[Square](https://square.github.io/okhttp/),\n[Uber](https://uber-go.github.io/fx/),\n[Zalando](https://opensource.zalando.com/skipper/)\n\n### ... and successful Open Source projects\n\n[Amp](https://amp.rs/docs/),\n[Arduino](https://arduino.github.io/arduino-cli/),\n[Auto-GPT](https://docs.agpt.co/),\n[AutoKeras](https://autokeras.com/),\n[BFE](https://www.bfe-networks.net/),\n[CentOS](https://docs.infra.centos.org/),\n[Crystal](https://crystal-lang.org/reference/),\n[eBPF](https://ebpf-go.dev/),\n[Electron](https://www.electron.build/),\n[FastAPI](https://fastapi.tiangolo.com/),\n[Freqtrade](https://www.freqtrade.io/en/stable/),\n[GoReleaser](https://goreleaser.com/),\n[HedgeDoc](https://docs.hedgedoc.org/),\n[Hummingbot](https://hummingbot.org/),\n[Knative](https://knative.dev/docs/),\n[Kubernetes](https://kops.sigs.k8s.io/),\n[kSQL](https://docs.ksqldb.io/),\n[NetBox](https://netboxlabs.com/docs/netbox/en/stable/),\n[Nokogiri](https://nokogiri.org/),\n[OpenFaaS](https://docs.openfaas.com/),\n[Orchard Core](https://docs.orchardcore.net/en/latest/),\n[Percona](https://docs.percona.com/percona-monitoring-and-management/),\n[Pi-Hole](https://docs.pi-hole.net/),\n[Pydantic](https://pydantic-docs.helpmanual.io/),\n[PyPI](https://docs.pypi.org/),\n[Renovate](https://docs.renovatebot.com/),\n[RetroPie](https://retropie.org.uk/docs/),\n[Supervision](https://supervision.roboflow.com/latest/),\n[Traefik](https://docs.traefik.io/),\n[Trivy](https://aquasecurity.github.io/trivy/),\n[Typer](https://typer.tiangolo.com/),\n[tinygrad](https://docs.tinygrad.org/),\n[Ultralytics](https://docs.ultralytics.com/),\n[Vapor](https://docs.vapor.codes/),\n[WebKit](https://docs.webkit.org/),\n[WTF](https://wtfutil.com/),\n[ZeroNet](https://zeronet.io/docs/)\n\n## License\n\n**MIT License**\n\nCopyright (c) 2016-2024 Martin Donath\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to\ndeal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or\nsell copies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\nIN THE SOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Documentation that simply works",
"version": "9.5.44",
"project_urls": {
"Changelog": "https://squidfunk.github.io/mkdocs-material/changelog/",
"Documentation": "https://squidfunk.github.io/mkdocs-material/",
"Funding": "https://github.com/sponsors/squidfunk",
"Issues": "https://github.com/squidfunk/mkdocs-material/issues",
"Source": "https://github.com/squidfunk/mkdocs-material"
},
"split_keywords": [
"documentation",
" mkdocs",
" theme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "edeba801d00e0e210d82184aacce596906ec065422c78a7319244ba0771c4ded",
"md5": "94b6037bb38fb159832ceb1ff100b87c",
"sha256": "47015f9c167d58a5ff5e682da37441fc4d66a1c79334bfc08d774763cacf69ca"
},
"downloads": -1,
"filename": "mkdocs_material-9.5.44-py3-none-any.whl",
"has_sig": false,
"md5_digest": "94b6037bb38fb159832ceb1ff100b87c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8674509,
"upload_time": "2024-11-05T18:23:35",
"upload_time_iso_8601": "2024-11-05T18:23:35.602998Z",
"url": "https://files.pythonhosted.org/packages/ed/eb/a801d00e0e210d82184aacce596906ec065422c78a7319244ba0771c4ded/mkdocs_material-9.5.44-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f756182d8121db9ab553cdf9bc58d5972b89833f60b63272f693c1f2b849b640",
"md5": "f296efaa74ace9f24b2d3e3b0ce38919",
"sha256": "f3a6c968e524166b3f3ed1fb97d3ed3e0091183b0545cedf7156a2a6804c56c0"
},
"downloads": -1,
"filename": "mkdocs_material-9.5.44.tar.gz",
"has_sig": false,
"md5_digest": "f296efaa74ace9f24b2d3e3b0ce38919",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3964306,
"upload_time": "2024-11-05T18:23:39",
"upload_time_iso_8601": "2024-11-05T18:23:39.001999Z",
"url": "https://files.pythonhosted.org/packages/f7/56/182d8121db9ab553cdf9bc58d5972b89833f60b63272f693c1f2b849b640/mkdocs_material-9.5.44.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 18:23:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sponsors",
"github_project": "squidfunk",
"github_not_found": true,
"lcname": "mkdocs-material"
}
