Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/squidfunk/mkdocs-material

Documentation that simply works
https://github.com/squidfunk/mkdocs-material

documentation framework material-design mkdocs plugins theme

Last synced: 2 months ago
JSON representation

Documentation that simply works

Lists

README 

        


  

    Material for MkDocs

  






  

    A powerful documentation framework on top of

    MkDocs

  






  Build

  Downloads

  Python Package Index

  Docker Pulls

  Sponsors






  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.






  

    

  






  

    Check out the demo –

    squidfunk.github.io/mkdocs-material.

  






 


Silver sponsors




  

  

  



 


Bronze sponsors




  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  

  



 



## 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/),

[Hewlett Packard](https://hewlettpackard.github.io/squest/),

[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/),

[Salesforce](https://policy-sentry.readthedocs.io/en/latest/),

[SIEMENS](https://opensource.siemens.com/),

[Slack](https://slackhq.github.io/circuit/),

[Square](https://square.github.io/okhttp/),

[Zalando](https://opensource.zalando.com/skipper/)



### ... and successful Open Source projects



[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/),

[Electron](https://www.electron.build/),

[FastAPI](https://fastapi.tiangolo.com/),

[GoReleaser](https://goreleaser.com/),

[Knative](https://knative.dev/docs/),

[Kubernetes](https://kops.sigs.k8s.io/),

[kSQL](https://docs.ksqldb.io/),

[Nokogiri](https://nokogiri.org/),

[OpenFaaS](https://docs.openfaas.com/),

[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/),

[Traefik](https://docs.traefik.io/),

[Trivy](https://aquasecurity.github.io/trivy/),

[Vapor](https://docs.vapor.codes/),

[ZeroNet](https://zeronet.io/docs/),

[WebKit](https://docs.webkit.org/),

[WTF](https://wtfutil.com/)



## 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.