    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

              Uh oh!

              There was an error while loading. Please reload this page.

              mkdocs / mkdocs Public

                      * Uh oh!

                        There was an error while loading. Please reload this page.

              * Notifications You must be signed in to change notification settings
              * Fork 2.6k
                * Star 22.3k
          * Code
          * Issues 120
          * Pull requests 68
          * Discussions
          * Actions
          * Security and quality 0
          * 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             
                                                                    
                                                2,118 Commits       
                                                  2,118 Commits     
                                                  .github/ workflows          .github/ workflows                                           
                                                  docs                        docs                                                         
                                                  mkdocs                      mkdocs                                                       
                                                  requirements                requirements                                                 
                                                  .codecov.yml                .codecov.yml                                                 
                                                  .coveragerc                 .coveragerc                                                  
                                                  .editorconfig               .editorconfig                                                
                                                  .gitattributes              .gitattributes                                               
                                                  .gitignore                  .gitignore                                                   
                                                  .jshintignore               .jshintignore                                                
                                                  .markdownlint.yaml          .markdownlint.yaml                                           
                                                  CONTRIBUTING.md             CONTRIBUTING.md                                              
                                                  FUNDING.yml                 FUNDING.yml                                                  
                                                  LICENSE                     LICENSE                                                      
                                                  README.md                   README.md                                                    
                                                  hatch_build.py              hatch_build.py                                               
                                                  mkdocs.yml                  mkdocs.yml                                                   
                                                  pyproject.toml              pyproject.toml                                               
                                                  setup.py                    setup.py                                                     
                                            View all files          
                                          

                                              Repository files navigation

                                                * 
                                                * README
                                                * Contributing
                                                * BSD-2-Clause license
                                                More items

                                                MkDocs

                                              Project documentation with Markdown

                                              MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

                                              Please see the Documentation for an introductory tutorial and a full user guide.

                                                Features

                                                * Build static HTML files from Markdown files.
                                                * Use Plugins and Markdown Extensions to enhance MkDocs.
                                                * Use the built-in themes, third party themes or create your own.
                                                * Publish your documentation anywhere that static files can be served.
                                                * Much more!

                                                Support

                                              If you need help with MkDocs, do not hesitate to get in contact with us!

                                                * For questions and high-level discussions, use Discussions on GitHub.
                                                    + For small questions, a good alternative is the Chat room on Gitter/Matrix.
                                                * To report a bug or make a feature request, open an Issue on GitHub.

                                              Please note that we may only provide support for problems/questions regarding core features of MkDocs. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects.
                                              But, such questions are not banned from the chat room.

                                              Make sure to stick around to answer some questions as well!

                                                Links

                                                * Official Documentation
                                                * Latest Release Notes
                                                * Catalog of third-party plugins, themes and recipes

                                                Contributing to MkDocs

                                              The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

                                                Code of Conduct

                                              Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.

                                                License

                                              BSD-2-Clause

                                        About

                                        Project documentation with Markdown.

                                          www.mkdocs.org

                                        Topics

                                          documentationmarkdownmkdocspythonstatic-site-generator

                                        Resources

                                          Readme
                                          BSD-2-Clause license

                                        Contributing

                                          Contributing
                                          Activity
                                          Custom properties

                                        Stars

                                          22.3k stars

                                        Watchers

                                          223 watching

                                        Forks

                                          2.6k forks
                                          Report repository

                                        Releases

                                        Sponsor this project

                                        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.