|
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| docs | ||
| material | ||
| src | ||
| tools/build | ||
| typings | ||
| .browserslistrc | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitattributes | ||
| .gitignore | ||
| .stylelintignore | ||
| .stylelintrc | ||
| CHANGELOG | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| giscus.json | ||
| LICENSE | ||
| mkdocs.yml | ||
| package-lock.json | ||
| package.json | ||
| pyproject.toml | ||
| README.md | ||
| requirements.txt | ||
| setup.py | ||
| tsconfig.json | ||
A Material Design theme for 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 50 languages, for all devices.
Check out the demo – squidfunk.github.io/mkdocs-material.
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 10,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:
pip install mkdocs-material
Add the following lines to mkdocs.yml:
theme:
name: material
For detailed installation instructions, configuration options, and a demo, visit squidfunk.github.io/mkdocs-material
Trusted by ...
... industry leaders
Atlassian, AWS, Bloomberg, CERN, Datadog, Google, Hewlett Packard, ING, Intel, JetBrains, LinkedIn, Microsoft, Mozilla, Netflix, Salesforce, SoundCloud, Square, Zalando
... and successful Open Source projects
Arduino, AutoKeras, BFE, CentOS, Crystal, Electron, FastAPI, GoReleaser, Knative, Kubernetes, kSQL, MindsDB, Nokogiri, OpenFaaS, Percona, Pi-Hole, Pydantic, Renovate, Traefik, Vapor, ZeroNet, WTF
License
MIT License
Copyright (c) 2016-2022 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.