MkDocs

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content="Project documentation with Markdown."> <meta name="author" content="MkDocs Team"> <link rel="canonical" href="https://www.mkdocs.org/"> <link rel="shortcut icon" href="img/favicon.ico"> <title>MkDocs</title> <link href="css/bootstrap.min.css" rel="stylesheet"> <link href="css/font-awesome.min.css" rel="stylesheet"> <link href="css/base.css" rel="stylesheet"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css"> <link href="assets/_mkdocstrings.css" rel="stylesheet"> <link href="css/extra.css" rel="stylesheet"> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/yaml.min.js"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/django.min.js"></script> <script>hljs.highlightAll();</script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-274394082"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', "G-274394082"); </script> </head> <body class="homepage"> <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary"> <div class="container"> <a class="navbar-brand" href=".">MkDocs</a>  <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse"> <span class="navbar-toggler-icon"></span> </button>  <div id="navbar-collapse" class="navbar-collapse collapse">  <ul class="nav navbar-nav"> <li class="navitem active"> <a href="." class="nav-link">Home</a> </li> <li class="navitem"> <a href="getting-started/" class="nav-link">Getting Started</a> </li> <li class="dropdown"> <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">User Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li> <a href="user-guide/" class="dropdown-item">User Guide</a> </li> <li> <a href="user-guide/installation/" class="dropdown-item">Installation</a> </li> <li> <a href="user-guide/writing-your-docs/" class="dropdown-item">Writing Your Docs</a> </li> <li> <a href="user-guide/choosing-your-theme/" class="dropdown-item">Choosing Your Theme</a> </li> <li> <a href="user-guide/customizing-your-theme/" class="dropdown-item">Customizing Your Theme</a> </li> <li> <a href="user-guide/localizing-your-theme/" class="dropdown-item">Localizing Your Theme</a> </li> <li> <a href="user-guide/configuration/" class="dropdown-item">Configuration</a> </li> <li> <a href="user-guide/cli/" class="dropdown-item">Command Line Interface</a> </li> <li> <a href="user-guide/deploying-your-docs/" class="dropdown-item">Deploying Your Docs</a> </li> </ul> </li> <li class="dropdown"> <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">Developer Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li> <a href="dev-guide/" class="dropdown-item">Developer Guide</a> </li> <li> <a href="dev-guide/themes/" class="dropdown-item">Themes</a> </li> <li> <a href="dev-guide/translations/" class="dropdown-item">Translations</a> </li> <li> <a href="dev-guide/plugins/" class="dropdown-item">Plugins</a> </li> <li> <a href="dev-guide/api/" class="dropdown-item">API Reference</a> </li> </ul> </li> <li class="dropdown"> <a href="#" class="nav-link dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a> <ul class="dropdown-menu"> <li> <a href="about/release-notes/" class="dropdown-item">Release Notes</a> </li> <li> <a href="about/contributing/" class="dropdown-item">Contributing</a> </li> <li> <a href="about/license/" class="dropdown-item">License</a> </li> </ul> </li> </ul> <ul class="nav navbar-nav ml-auto"> <li class="nav-item"> <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal"> <i class="fa fa-search"></i> Search </a> </li> <li class="nav-item"> <a rel="prev" class="nav-link disabled"> <i class="fa fa-arrow-left"></i> Previous </a> </li> <li class="nav-item"> <a rel="next" href="getting-started/" class="nav-link"> Next <i class="fa fa-arrow-right"></i> </a> </li> <li class="nav-item"> <a href="https://github.com/mkdocs/mkdocs/blob/master/docs/index.md" class="nav-link"><i class="fa fa-github"></i> Edit on GitHub</a> </li> </ul> </div> </div> </div> <div class="container"> <div class="row"> <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary"> <div class="navbar-header"> <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents"> <span class="fa fa-angle-down"></span> </button> </div> <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary"> <ul class="nav flex-column"> <li class="nav-item" data-level="1"><a href="#mkdocs" class="nav-link">MkDocs</a> <ul class="nav flex-column"> </ul> </li> </ul> </div> </div></div> <div class="col-md-9" role="main"> <h1 id="mkdocs">MkDocs<a class="headerlink" href="#mkdocs" title="Permanent link"></a></h1> <p>Project documentation with Markdown.</p> <hr /> <p>MkDocs is a <strong>fast</strong>, <strong>simple</strong> and <strong>downright gorgeous</strong> 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. Start by reading the <a href="getting-started/">introductory tutorial</a>, then check the <a href="user-guide/">User Guide</a> for more information.</p> <div class="text-center"> <a href="getting-started/" class="btn btn-primary" role="button">Getting Started</a> <a href="user-guide/" class="btn btn-primary" role="button">User Guide</a> </div> <div class="pt-2 pb-4 px-4 my-4 bg-body-tertiary rounded-3"> <h2 class="display-4 text-center">Features</h2> <div class="row"> <div class="col-sm-6"> <div class="card mb-4"> <div class="card-body"> <h3 class="card-title">Great themes available</h3> <p class="card-text"> There's a stack of good looking <a href="user-guide/choosing-your-theme">themes</a> available for MkDocs. Choose between the built in themes: <a href="user-guide/choosing-your-theme/#mkdocs">mkdocs</a> and <a href="user-guide/choosing-your-theme/#readthedocs">readthedocs</a>, select one of the third-party themes (on the <a href="https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes">MkDocs Themes</a> wiki page as well as the <a href="https://github.com/mkdocs/catalog#-theming">MkDocs Catalog</a>), or <a href="dev-guide/themes/">build your own</a>. </p> </div> </div> </div> <div class="col-sm-6"> <div class="card mb-4"> <div class="card-body"> <h3 class="card-title">Easy to customize</h3> <p class="card-text"> Get your project documentation looking just the way you want it by <a href="user-guide/customizing-your-theme/">customizing your theme</a> and/or installing some <a href="user-guide/configuration/#plugins">plugins</a>. Modify Markdown's behavior with <a href="user-guide/configuration/#markdown_extensions">Markdown extensions</a>. Many <a href="user-guide/configuration/">configuration options</a> are available. </p> </div> </div> </div> </div> <div class="row"> <div class="col-sm-6"> <div class="card"> <div class="card-body"> <h3 class="card-title">Preview your site as you work</h3> <p class="card-text"> The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes. </p> </div> </div> </div> <div class="col-sm-6"> <div class="card"> <div class="card-body"> <h3 class="card-title">Host anywhere</h3> <p class="card-text"> MkDocs builds completely static HTML sites that you can host on GitHub Pages, Amazon S3, or <a href="user-guide/deploying-your-docs/">anywhere</a> else you choose. </p> </div> </div> </div> </div> </div></div> </div> </div> <footer class="col-md-12"> <hr> <p>Copyright © 2014 <a href="https://twitter.com/starletdreaming">Tom Christie</a>, Maintained by the <a href="/about/release-notes/#maintenance-team">MkDocs Team</a>.</p> <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p> </footer> <script src="js/jquery-3.6.0.min.js"></script> <script src="js/bootstrap.min.js"></script> <script> var base_url = ".", shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83}; </script> <script src="js/base.js"></script> <script src="search/main.js"></script> <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true"> <div class="modal-dialog modal-lg"> <div class="modal-content"> <div class="modal-header"> <h4 class="modal-title" id="searchModalLabel">Search</h4> <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> </div> <div class="modal-body"> <p>From here you can search these documents. Enter your search terms below.</p> <form> <div class="form-group"> <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here"> </div> </form> <div id="mkdocs-search-results" data-no-results-text="No results found"></div> </div> <div class="modal-footer"> </div> </div> </div> </div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4> <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> </div> <div class="modal-body"> <table class="table"> <thead> <tr> <th style="width: 20%;">Keys</th> <th>Action</th> </tr> </thead> <tbody> <tr> <td class="help shortcut"><kbd>?</kbd></td> <td>Open this help</td> </tr> <tr> <td class="next shortcut"><kbd>n</kbd></td> <td>Next page</td> </tr> <tr> <td class="prev shortcut"><kbd>p</kbd></td> <td>Previous page</td> </tr> <tr> <td class="search shortcut"><kbd>s</kbd></td> <td>Search</td> </tr> </tbody> </table> </div> <div class="modal-footer"> </div> </div> </div> </div> </body> </html>

CINXE.COM

MkDocs