\n \n $\"Material$ \n \n

\n\n

\n \n A \n Material Design \n theme for \n MkDocs\n \n

\n\n

\n \n \n $\"Chat$ \n $\"Python$ \n $\"Docker$ \n

\n\n

\n Write your documentation in Markdown and create a professional static site for\n your Open Source or commercial project in minutes – searchable, customizable,\n more than 50 languages, for all devices.\n

\n\n

\n \n \n \n

\n\n

\n \n Check out the demo – \n squidfunk.github.io/mkdocs-material.\n \n

\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 in minutes. No need to know HTML, CSS or JavaScript – let Material for MkDocs do the heavy lifting for you.\n\n### Works on all devices\n\nServe 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.\n\n### Made to measure\n\nMake 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.\n\n### Fast and lightweight\n\nDon'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.\n\n### Maintain ownership\n\nOwn your documentation's complete sources and outputs, guaranteeing both integrity and security – no need to entrust the backbone of your product knowledge to third-party platforms. Retain full control.\n\n### Open Source\n\nYou're in good company – choose a mature and actively maintained solution built with state-of-the-art Open Source technologies, trusted by more than 50.000 individuals and organizations. Licensed under MIT.\n\n## Become a sponsor\n\nBy joining the [Insiders] program, you'll get immediate access to the latest\nfeatures while also helping support the ongoing development of Material for\nMkDocs. Thanks to our [awesome sponsors], this project is actively maintained\nand kept in good shape.\n\n [Insiders]: https://squidfunk.github.io/mkdocs-material/insiders/\n [awesome sponsors]: https://squidfunk.github.io/mkdocs-material/insiders/our-sponsors/\n\n## Quick start\n\nAdd the following line to your `mkdocs.yml`:\n\n``` yaml\ntheme:\n name: 'material'\n```\n\nMount the folder where your `mkdocs.yml` resides as a volume into `/docs`:\n\n### Start development server\n\n``` sh\ndocker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material\n```\n\n### Build documentation\n\n``` sh\ndocker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material build\n```\n\n### Deploy documentation to GitHub Pages\n\n``` sh\ndocker run --rm -it -v ~/.ssh:/root/.ssh -v ${PWD}:/docs squidfunk/mkdocs-material gh-deploy \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[OpenSSL](https://docs.openssl.org/),\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-2022 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","has_starred","hub_user","immutable_tags_settings",{"_172":11,"_173":174},"enabled","rules",[175],".*","is_automated","permissions",{"_179":22,"_180":11,"_181":11},"read","write","admin","user","storage_size",24961175773,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_28":29,"_133":-7,"_131":-7,"_132":-7,"_30":196,"_36":47,"_201":202,"_209":11},{"_32":33,"_34":35,"_36":37,"_38":39,"_40":41,"_42":197,"_75":76,"_77":35,"_78":79,"_80":81,"_82":83,"_84":85,"_86":51,"_87":76,"_88":60,"_89":22},[198,199,200],{"_45":46,"_36":47,"_48":49,"_50":51,"_52":53,"_54":55,"_56":49,"_57":-5,"_58":39,"_59":60,"_61":-5},{"_45":63,"_36":64,"_48":49,"_50":65,"_52":66,"_54":55,"_56":49,"_57":-5,"_58":67,"_59":60,"_61":-5},{"_45":69,"_36":70,"_48":49,"_50":71,"_52":72,"_54":55,"_56":49,"_57":-5,"_58":73,"_59":60,"_61":74},"imageWithLayers",{"_45":46,"_36":47,"_48":49,"_50":51,"_52":53,"_93":203,"_54":55,"_56":49,"_57":-5,"_58":39,"_59":60,"_61":-5},[204,205,206,207,208],{"_36":96,"_58":97,"_98":99},{"_36":101,"_58":102,"_98":103},{"_58":105,"_98":106,"_36":49},{"_58":105,"_98":108,"_36":49},{"_58":105,"_98":110,"_36":49},"hasPermissionToViewRepoSettings","actionData","errors"]

squidfunk/mkdocs-material:latest