Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

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

documentation framework material-design mkdocs plugins theme

Last synced: 5 days ago
JSON representation

Documentation that simply works

Host: GitHub
URL: https://squidfunk.github.io/mkdocs-material/
Owner: squidfunk
License: mit
Created: 2016-01-28T22:09:23.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2024-05-01T21:11:14.000Z (6 months ago)
Last Synced: 2024-05-02T00:28:42.561Z (6 months ago)
Topics: documentation, framework, material-design, mkdocs, plugins, theme
Language: HTML
Homepage: https://squidfunk.github.io/mkdocs-material/
Size: 125 MB
Stars: 18,317
Watchers: 127
Forks: 3,321
Open Issues: 32
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

dereks-awesome-list - MKDocs Material - Create a branded static site from a set of Markdown files to host the documentation of your Open Source or commercial project. Set up in 5 minutes. (Documentation)
awesome-docs - Material for MkDocs

README

        


  

    

  





  

    A powerful documentation framework on top of

    MkDocs

  





  

  

  

  

  





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

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