    Skip to content

      Navigation Menu

            Sign in Appearance settings
                * Platform
                        + AI CODE CREATION
                            o GitHub Copilot Write better code with AI
                            o GitHub Copilot app Direct agents from issue to merge
                            o MCP Registry Integrate external tools
                        + DEVELOPER WORKFLOWS
                            o Actions Automate any workflow
                            o Codespaces Instant dev environments
                            o Issues Plan and track work
                            o Code Review Manage code changes
                            o Code Quality Enforce quality at merge
                        + APPLICATION SECURITY
                            o GitHub Advanced Security Find and fix vulnerabilities
                            o Code security Secure your code as you build
                            o Secret protection Stop leaks before they start
                        + EXPLORE
                            o Why GitHub
                            o Documentation
                            o Blog
                            o Changelog
                            o Marketplace
                      View all features
                * Solutions
                        + BY COMPANY SIZE
                            o Enterprises
                            o Small and medium teams
                            o Startups
                            o Nonprofits
                        + BY USE CASE
                            o App Modernization
                            o DevSecOps
                            o DevOps
                            o CI/CD
                            o View all use cases
                        + BY INDUSTRY
                            o Healthcare
                            o Financial services
                            o Manufacturing
                            o Government
                            o View all industries
                      View all solutions
                * Resources
                        + EXPLORE BY TOPIC
                            o AI
                            o Software Development
                            o DevOps
                            o Security
                            o View all topics
                        + EXPLORE BY TYPE
                            o Customer stories
                            o Events & webinars
                            o Ebooks & reports
                            o Business insights
                            o GitHub Skills
                        + SUPPORT & SERVICES
                            o Documentation
                            o Customer support
                            o Community forum
                            o Trust center
                            o Partners
                      View all resources
                * Open Source
                        + COMMUNITY
                            o GitHub Sponsors Fund open source developers
                        + PROGRAMS
                            o Security Lab
                            o Maintainer Community
                            o Accelerator
                            o GitHub Stars
                            o Archive Program
                        + REPOSITORIES
                            o Topics
                            o Trending
                            o Collections
                * Enterprise
                        + ENTERPRISE SOLUTIONS
                            o Enterprise platform AI-powered developer platform
                        + AVAILABLE ADD-ONS
                            o GitHub Advanced Security Enterprise-grade security features
                            o Copilot for Business Enterprise-grade AI features
                            o Premium Support Enterprise-grade 24/7 support
              * Pricing
                Type / to search
                Sign in
              Sign up Appearance settings
      You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert
              squidfunk / mkdocs-material Public
              * Notifications You must be signed in to change notification settings
              * Fork 4.1k
                * Star 27.2k
          * Code
          * Issues 1
          * Pull requests 0
          * Discussions
          * Actions
          * Security and quality 1
          * Insights
          Additional navigation options
                  * Code
                  * Issues
                  * Pull requests
                  * Discussions
                  * Actions
                  * Security and quality
                  * Insights
                                              master
                                          Branches Tags
                                            Go to file
                                        Code
                                          Open more actions menu

                                        Folders and files

                                          Name                        Name                          Last commit message    Last commit date
                                            Latest commit           
                                                                    
                                                History             
                                                                    
                                                6,763 Commits       
                                                  6,763 Commits     
                                                  .devcontainer               .devcontainer                                                
                                                  .github                     .github                                                      
                                                  .vscode                     .vscode                                                      
                                                  docs                        docs                                                         
                                                  includes                    includes                                                     
                                                  material                    material                                                     
                                                  src                         src                                                          
                                                  tools/ build                tools/ build                                                 
                                                  typings                     typings                                                      
                                                  .browserslistrc             .browserslistrc                                              
                                                  .dockerignore               .dockerignore                                                
                                                  .editorconfig               .editorconfig                                                
                                                  .eslintignore               .eslintignore                                                
                                                  .eslintrc                   .eslintrc                                                    
                                                  .gitattributes              .gitattributes                                               
                                                  .gitignore                  .gitignore                                                   
                                                  .stylelintignore            .stylelintignore                                             
                                                  .stylelintrc                .stylelintrc                                                 
                                                  CHANGELOG                   CHANGELOG                                                    
                                                  CODE_OF_CONDUCT.md          CODE_OF_CONDUCT.md                                           
                                                  CONTRIBUTING.md             CONTRIBUTING.md                                              
                                                  Dockerfile                  Dockerfile                                                   
                                                  LICENSE                     LICENSE                                                      
                                                  README.md                   README.md                                                    
                                                  SECURITY.md                 SECURITY.md                                                  
                                                  mkdocs.yml                  mkdocs.yml                                                   
                                                  package-lock.json           package-lock.json                                            
                                                  package.json                package.json                                                 
                                                  pyproject.toml              pyproject.toml                                               
                                                  requirements.txt            requirements.txt                                             
                                                  tsconfig.json               tsconfig.json                                                
                                            View all files          
                                          

                                              Repository files navigation

                                                * 
                                                * README
                                                * Code of conduct
                                                * Contributing
                                                * MIT license
                                                * Security
                                                More items

                                              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.

                                                Maintain ownership

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

                                                Open Source

                                              You'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.

                                                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

                                              ArXiv, Atlassian, AWS, Bloomberg, CERN, Datadog, Google, Harvard, Hewlett Packard, HSBC, ING, Intel, JetBrains, LinkedIn, Microsoft, Mozilla, Netflix, OpenAI, Red Hat, Roboflow, Salesforce, SIEMENS, Slack, Square, Uber, Zalando

                                                ... and successful Open Source projects

                                              Amp, Apache Iceberg, Arduino, Asahi Linux, Auto-GPT, AutoKeras, BFE, CentOS, Crystal, eBPF, ejabberd, Electron, FastAPI, FlatBuffers, {fmt}, Freqtrade, GoReleaser, GraphRAG, Headscale, HedgeDoc, Hummingbot, Knative, Kubernetes, kSQL, LeakCanary, LlamaIndex, NetBox, Nokogiri, OpenAI, OpenFaaS, OpenSSL, Orchard Core, Percona, Pi-Hole, Polars, Pydantic, PyPI, Quivr, Renovate, RetroPie, Ruff, Supervision, Textual, Traefik, Trivy, Typer, tinygrad, Ultralytics, UV, Vapor, WebKit, WTF, ZeroNet

                                                License

                                              MIT License

                                              Copyright (c) 2016-2025 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.

                                        About

                                        Documentation that simply works

                                          squidfunk.github.io/mkdocs-material/

                                        Topics

                                          documentationframeworkmaterial-designmkdocspluginstheme

                                        Resources

                                          Readme
                                          MIT license

                                        Code of conduct

                                          Code of conduct

                                        Contributing

                                          Contributing

                                        Security policy

                                          Security policy
                                          Activity

                                        Stars

                                          27.2k stars

                                        Watchers

                                          144 watching

                                        Forks

                                          4.1k forks
                                          Report repository

                                        Releases

                                        Packages

                                        Used by

                                        Contributors

                                        Languages

    Footer

        © 2026 GitHub, Inc.

      Footer navigation

        * Terms
        * Privacy
        * Security
        * Status
        * Community
        * Docs
        * Contact
        * Manage cookies
        * Do not share my personal information
      You can’t perform that action at this time.