CINXE.COM

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices"><meta name=author content="Martin Donath"><link href=https://squidfunk.github.io/mkdocs-material/ rel=canonical><link href=getting-started/ rel=next><link rel=alternate type=application/rss+xml title="RSS feed" href=feed_rss_created.xml><link rel=alternate type=application/rss+xml title="RSS feed of updated content" href=feed_rss_updated.xml><link rel=icon href=assets/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.6.4+insiders-4.53.15"><title>Material for MkDocs</title><link rel=stylesheet href=assets/stylesheets/main.f15084e1.min.css><link rel=stylesheet href=assets/stylesheets/palette.ab4e12ef.min.css><link rel=stylesheet href=assets/stylesheets/custom.c27ceb93.min.css><link rel=stylesheet href=assets/stylesheets/home.ac698b0a.min.css><script>"Apple Computer, Inc."===navigator.vendor&&document.documentElement.classList.add("safari")</script><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=css/timeago.css><script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><script id=__analytics>function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-YBH0NE3T7R"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-YBH0NE3T7R",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-YBH0NE3T7R",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script><script>"undefined"!=typeof __md_analytics&&__md_analytics()</script><link rel=me href=https://fosstodon.org/@squidfunk><meta property=og:type content=website><meta property=og:title content="Material for MkDocs"><meta property=og:description content="Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices"><meta property=og:image content=https://squidfunk.github.io/mkdocs-material/assets/images/social/index.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://squidfunk.github.io/mkdocs-material/ property=og:url><meta property=twitter:card content=summary_large_image><meta property=twitter:title content="Material for MkDocs"><meta property=twitter:description content="Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices"><meta property=twitter:image content=https://squidfunk.github.io/mkdocs-material/assets/images/social/index.png></head> <body dir=ltr data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=. title="Material for MkDocs" class="md-header__button md-logo" aria-label="Material for MkDocs" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 89 89"> <path d=M3.136,17.387l0,42.932l42.932,21.467l-42.932,-64.399Z /> <path d=M21.91,8l42.933,64.398l-18.775,9.388l-42.932,-64.399l18.774,-9.387Z style="fill-opacity: 0.5"/> <path d=M67.535,17.387l-27.262,18.156l21.878,32.818l5.384,2.691l0,-53.665Z /> <path d=M67.535,17.387l0,53.666l18.774,-9.388l0,-53.665l-18.774,9.387Z style="fill-opacity: 0.25"/> </svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Material for MkDocs </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Material for MkDocs </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media=(prefers-color-scheme) data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1M8 13h8v-2H8zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4a5 5 0 0 0 5-5 5 5 0 0 0-5-5"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_2 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=black data-md-color-accent=indigo aria-label="Switch to system preference" type=radio name=__palette id=__palette_2> <label class="md-header__button md-icon" title="Switch to system preference" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5M7 15a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/squidfunk/mkdocs-material title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class=md-source__repository> squidfunk/mkdocs-material </div> </a> </div> </nav> </header> <div class=md-container data-md-component=container> <div class=mdx-parallax data-mdx-component=parallax> <section class=mdx-parallax__group data-md-color-scheme=slate> <picture class=mdx-parallax__layer style="--md-parallax-depth: 8;--md-image-position: 70%"> <source type=image/avif srcset="assets/images/layers/1-landscape.avif 1280w, assets/images/layers/1-landscape@2x.avif 1920w, assets/images/layers/1-landscape@3x.avif 2560w, assets/images/layers/1-landscape@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/1-landscape.webp 1280w, assets/images/layers/1-landscape@2x.webp 1920w, assets/images/layers/1-landscape@3x.webp 2560w, assets/images/layers/1-landscape@4x.webp 3840w"> <img srcset="assets/images/layers/1-landscape.png 1280w, assets/images/layers/1-landscape@2x.png 1920w, assets/images/layers/1-landscape@3x.png 2560w, assets/images/layers/1-landscape@4x.png 3840w" src=assets/images/layers/1-landscape.png alt class=mdx-parallax__image> </picture> <picture class=mdx-parallax__layer style="--md-parallax-depth: 5;--md-image-position: 25%"> <source type=image/avif srcset="assets/images/layers/2-plateau.avif 1280w, assets/images/layers/2-plateau@2x.avif 1920w, assets/images/layers/2-plateau@3x.avif 2560w, assets/images/layers/2-plateau@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/2-plateau.webp 1280w, assets/images/layers/2-plateau@2x.webp 1920w, assets/images/layers/2-plateau@3x.webp 2560w, assets/images/layers/2-plateau@4x.webp 3840w"> <img srcset="assets/images/layers/2-plateau.png 1280w, assets/images/layers/2-plateau@2x.png 1920w, assets/images/layers/2-plateau@3x.png 2560w, assets/images/layers/2-plateau@4x.png 3840w" src=assets/images/layers/2-plateau.png alt class=mdx-parallax__image> </picture> <picture class=mdx-parallax__layer style="--md-parallax-depth: 4;--md-image-position: 20%"> <source type=image/avif srcset="assets/images/layers/3-astronaut-1.avif 1280w, assets/images/layers/3-astronaut-1@2x.avif 1920w, assets/images/layers/3-astronaut-1@3x.avif 2560w, assets/images/layers/3-astronaut-1@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/3-astronaut-1.webp 1280w, assets/images/layers/3-astronaut-1@2x.webp 1920w, assets/images/layers/3-astronaut-1@3x.webp 2560w, assets/images/layers/3-astronaut-1@4x.webp 3840w"> <img srcset="assets/images/layers/3-astronaut-1.png 1280w, assets/images/layers/3-astronaut-1@2x.png 1920w, assets/images/layers/3-astronaut-1@3x.png 2560w, assets/images/layers/3-astronaut-1@4x.png 3840w" src=assets/images/layers/3-astronaut-1.png alt class=mdx-parallax__image> </picture> <picture class=mdx-parallax__layer style="--md-parallax-depth: 3;--md-image-position: 30%"> <source type=image/avif srcset="assets/images/layers/4-astronaut-2.avif 1280w, assets/images/layers/4-astronaut-2@2x.avif 1920w, assets/images/layers/4-astronaut-2@3x.avif 2560w, assets/images/layers/4-astronaut-2@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/4-astronaut-2.webp 1280w, assets/images/layers/4-astronaut-2@2x.webp 1920w, assets/images/layers/4-astronaut-2@3x.webp 2560w, assets/images/layers/4-astronaut-2@4x.webp 3840w"> <img srcset="assets/images/layers/4-astronaut-2.png 1280w, assets/images/layers/4-astronaut-2@2x.png 1920w, assets/images/layers/4-astronaut-2@3x.png 2560w, assets/images/layers/4-astronaut-2@4x.png 3840w" src=assets/images/layers/4-astronaut-2.png alt class=mdx-parallax__image> </picture> <picture class=mdx-parallax__layer style="--md-parallax-depth: 2;--md-image-position: 40%"> <source type=image/avif srcset="assets/images/layers/5-plants-1.avif 1280w, assets/images/layers/5-plants-1@2x.avif 1920w, assets/images/layers/5-plants-1@3x.avif 2560w, assets/images/layers/5-plants-1@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/5-plants-1.webp 1280w, assets/images/layers/5-plants-1@2x.webp 1920w, assets/images/layers/5-plants-1@3x.webp 2560w, assets/images/layers/5-plants-1@4x.webp 3840w"> <img srcset="assets/images/layers/5-plants-1.png 1280w, assets/images/layers/5-plants-1@2x.png 1920w, assets/images/layers/5-plants-1@3x.png 2560w, assets/images/layers/5-plants-1@4x.png 3840w" src=assets/images/layers/5-plants-1.png alt class=mdx-parallax__image> </picture> <picture class=mdx-parallax__layer style="--md-parallax-depth: 1;--md-image-position: 50%"> <source type=image/avif srcset="assets/images/layers/6-plants-2.avif 1280w, assets/images/layers/6-plants-2@2x.avif 1920w, assets/images/layers/6-plants-2@3x.avif 2560w, assets/images/layers/6-plants-2@4x.avif 3840w"> <source type=image/webp srcset="assets/images/layers/6-plants-2.webp 1280w, assets/images/layers/6-plants-2@2x.webp 1920w, assets/images/layers/6-plants-2@3x.webp 2560w, assets/images/layers/6-plants-2@4x.webp 3840w"> <img srcset="assets/images/layers/6-plants-2.png 1280w, assets/images/layers/6-plants-2@2x.png 1920w, assets/images/layers/6-plants-2@3x.png 2560w, assets/images/layers/6-plants-2@4x.png 3840w" src=assets/images/layers/6-plants-2.png alt class=mdx-parallax__image> </picture> <div class="mdx-parallax__layer mdx-parallax__blend"></div> <div class=mdx-hero data-mdx-component=hero> <div class="mdx-hero__scrollwrap md-grid"> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class="md-tabs__item md-tabs__item--active"> <a href=. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=getting-started/ class=md-tabs__link> Getting started </a> </li> <li class=md-tabs__item> <a href=setup/ class=md-tabs__link> Setup </a> </li> <li class=md-tabs__item> <a href=plugins/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=reference/ class=md-tabs__link> Reference </a> </li> <li class=md-tabs__item> <a href=insiders/ class=md-tabs__link> Insiders </a> </li> <li class=md-tabs__item> <a href=contributing/ class=md-tabs__link> Community </a> </li> <li class=md-tabs__item> <a href=blog/ class=md-tabs__link> Blog </a> </li> </ul> </div> </nav> <div class=mdx-hero__inner> <div class="mdx-hero__teaser md-typeset"> <h1>Documentation that simply works</h1> <p>Write your documentation in Markdown and create a professional static site in minutes – searchable, customizable, in 60+ languages, for all devices.</p> <a href=getting-started/ class=md-button> Get started </a> <a href=#everything-you-would-expect class="md-button md-button--secondary"> Learn more </a> </div> <div class=mdx-hero__more> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M11 4h2v12l5.5-5.5 1.42 1.42L12 19.84l-7.92-7.92L5.5 10.5 11 16z"/></svg> </div> </div> </div> </div> </section> <section class=mdx-parallax__group data-md-color-scheme=slate data-md-color-primary=indigo> <div class="md-content md-grid" data-md-component=content> <div class=md-content__inner> <header class=md-typeset hidden> <h1 id=everything-you-would-expect> Everything you would expect <a href=#everything-you-would-expect class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class=mdx-expect> <ul class=mdx-expect__list> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20.56 18H3.44C2.65 18 2 17.37 2 16.59V7.41C2 6.63 2.65 6 3.44 6h17.12c.79 0 1.44.63 1.44 1.41v9.18c0 .78-.65 1.41-1.44 1.41M6.81 15.19v-3.66l1.92 2.35 1.92-2.35v3.66h1.93V8.81h-1.93l-1.92 2.35-1.92-2.35H4.89v6.38zM19.69 12h-1.92V8.81h-1.92V12h-1.93l2.89 3.28z"/></svg> </div> <div class=mdx-expect__description> <h2>It's just Markdown</h2> <p> 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. </p> </div> </li> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18V4H3c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h4v-2H3zm10 6H9v1.78c-.61.55-1 1.33-1 2.22s.39 1.67 1 2.22V20h4v-1.78c.61-.55 1-1.34 1-2.22s-.39-1.67-1-2.22zm-2 5.5c-.83 0-1.5-.67-1.5-1.5s.67-1.5 1.5-1.5 1.5.67 1.5 1.5-.67 1.5-1.5 1.5M22 8h-6c-.5 0-1 .5-1 1v10c0 .5.5 1 1 1h6c.5 0 1-.5 1-1V9c0-.5-.5-1-1-1m-1 10h-4v-8h4z"/></svg> </div> <div class=mdx-expect__description> <h2>Works on all devices</h2> <p> 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. </p> </div> </li> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 8h3v12h1v1h-4v-1h1v-3h-4l-1.5 3H14v1h-4v-1h1zm1 1-3.5 7H18zM5 3h5c1.11 0 2 .89 2 2v11H9v-5H6v5H3V5c0-1.11.89-2 2-2m1 2v4h3V5z"/></svg> </div> <div class=mdx-expect__description> <h2>Made to measure</h2> <p> 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. </p> </div> </li> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 10a1 1 0 0 1-1-1 1 1 0 0 1 1-1h8a2 2 0 0 0 2-2 2 2 0 0 0-2-2c-.55 0-1.05.22-1.41.59a.973.973 0 0 1-1.42 0c-.39-.39-.39-1.03 0-1.42C9.9 2.45 10.9 2 12 2a4 4 0 0 1 4 4 4 4 0 0 1-4 4zm15 2a1 1 0 0 0 1-1 1 1 0 0 0-1-1c-.28 0-.53.11-.71.29a.996.996 0 0 1-1.41 0c-.38-.39-.38-1.02 0-1.41C17.42 8.34 18.17 8 19 8a3 3 0 0 1 3 3 3 3 0 0 1-3 3H5a1 1 0 0 1-1-1 1 1 0 0 1 1-1zm-1 6H4a1 1 0 0 1-1-1 1 1 0 0 1 1-1h14a3 3 0 0 1 3 3 3 3 0 0 1-3 3c-.83 0-1.58-.34-2.12-.88-.38-.39-.38-1.02 0-1.41a.996.996 0 0 1 1.41 0c.18.18.43.29.71.29a1 1 0 0 0 1-1 1 1 0 0 0-1-1"/></svg> </div> <div class=mdx-expect__description> <h2>Fast and lightweight</h2> <p> 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. </p> </div> </li> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12.67 13.67c-.47.46-1.04.83-1.67 1.06V23H8v-2H5v-3h3v-3.28c-1.74-.62-3-2.26-3-4.22C5 8 7 6 9.5 6h.1c-.47.95-.68 2-.57 3.08-.59.2-1.03.76-1.03 1.42 0 .83.67 1.5 1.5 1.5.23 0 .45-.06.65-.15.64.84 1.52 1.47 2.52 1.82m8.06 5.77-2.76 1.16-.78-1.84-2.76 1.17-1.17-2.77L16.03 16l-1.27-3c-1.85.08-3.65-.95-4.41-2.75-.96-2.29.12-4.93 2.41-5.9.24-.1.5-.17.74-.23C12.84 2.87 11.5 2 10 2 7.79 2 6 3.79 6 6v.24c-.3.26-.6.58-.85.91C5.06 6.78 5 6.4 5 6c0-2.76 2.24-5 5-5s5 2.24 5 5c0 1.42-.6 2.67-1.55 3.57.42.43 1.05.56 1.63.31.77-.32 1.12-1.2.8-1.96a1 1 0 0 0-.14-.26C15.9 7.13 16 6.58 16 6c0-.63-.1-1.24-.28-1.81 1.28.36 2.38 1.25 2.93 2.57.76 1.8.24 3.81-1.15 5.05zM13 8.6c.37-.41.65-.89.82-1.42-.54.27-.85.82-.82 1.42"/></svg> </div> <div class=mdx-expect__description> <h2>Maintain ownership</h2> <p> 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. </p> </div> </li> <li class="mdx-expect__item md-typeset" hidden> <div class=mdx-expect__icon> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"> <path d="M7.75 11c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 102.5 0v-1.5C9 11.56 8.44 11 7.75 11zm1.27 4.5a.469.469 0 01.48-.5h5a.47.47 0 01.48.5c-.116 1.316-.759 2.5-2.98 2.5s-2.864-1.184-2.98-2.5zm7.23-4.5c-.69 0-1.25.56-1.25 1.25v1.5a1.25 1.25 0 102.5 0v-1.5c0-.69-.56-1.25-1.25-1.25z"/> <path fill-rule=evenodd d="M21.255 3.82a1.725 1.725 0 00-2.141-1.195c-.557.16-1.406.44-2.264.866-.78.386-1.647.93-2.293 1.677A18.442 18.442 0 0012 5c-.93 0-1.784.059-2.569.17-.645-.74-1.505-1.28-2.28-1.664a13.876 13.876 0 00-2.265-.866 1.725 1.725 0 00-2.141 1.196 23.645 23.645 0 00-.69 3.292c-.125.97-.191 2.07-.066 3.112C1.254 11.882 1 13.734 1 15.527 1 19.915 3.13 23 12 23c8.87 0 11-3.053 11-7.473 0-1.794-.255-3.647-.99-5.29.127-1.046.06-2.15-.066-3.125a23.652 23.652 0 00-.689-3.292zM20.5 14c.5 3.5-1.5 6.5-8.5 6.5s-9-3-8.5-6.5c.583-4 3-6 8.5-6s7.928 2 8.5 6z"/> </svg> </div> <div class=mdx-expect__description> <h2>Open Source</h2> <p> 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 20.000 individuals and organizations. Licensed under MIT. </p> </div> </li> </ul> </div> </div> </div> </section> <section class=mdx-parallax__group data-md-color-scheme=default> <div class="md-content md-grid" data-md-component=content> <div class=md-content__inner> <header class=md-typeset hidden> <h1 id=more-than-just-a-static-site> More than just a static site <a href=#more-than-just-a-static-site class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class=mdx-spotlight> <figure class=mdx-spotlight__feature hidden> <a href=setup/setting-up-site-search/ title="Built-in search" tabindex=-1> <img src=assets/images/spotlight/built-in-search.png alt="Built-in search" loading=lazy width=500 height=327> </a> <figcaption class=md-typeset> <h2>Built-in search</h2> <p> Material for MkDocs makes your documentation <strong>instantly searchable</strong> with zero effort: say goodbye to costly third-party crawler-based solutions that can take hours to update. Ship your documentation with a <strong>highly customizable </strong> and <strong>blazing fast search</strong> running entirely <strong>in the user's browser</strong> at no extra cost. </p> <p> Even better: search inside code blocks, exclude specific sections or entire pages, boost important pages in the results and build searchable documentation that <strong>works offline</strong>. </p> <p> <a href=setup/setting-up-site-search/ aria-label="Built-in search"> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg> </span> Learn more </a> </p> </figcaption> </figure> <figure class=mdx-spotlight__feature hidden> <a href=reference/code-blocks/#code-annotations title="Code annotations" tabindex=-1> <img src=assets/images/spotlight/code-annotations.png alt="Code annotations" loading=lazy width=500 height=327> </a> <figcaption class=md-typeset> <h2>Code annotations</h2> <p> Some examples need more explanation than others, which is why Material for MkDocs offers a <strong>unique and elegant</strong> way to add <strong>rich text</strong> almost <strong>anywhere in a code block</strong>. </p> <p> Code annotations can host formatted <strong>text</strong>, <strong>images</strong>, <strong>diagrams</strong>, <strong>code blocks</strong>, call-outs, content tabs, even interactive elements – basically everything that can be expressed in Markdown or HTML. Of course, code annotations <strong>work beautifully on mobile</strong> and other touch devices <strong> and can be printed</strong>. <p> <a href=reference/code-blocks/#code-annotations aria-label="Code annotations"> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg> </span> Learn more </a> </p> </figcaption> </figure> <figure class=mdx-spotlight__feature hidden> <a href=setup/setting-up-social-cards/ title="Social cards" tabindex=-1> <img src=assets/images/spotlight/social-cards.png alt="Social cards" loading=lazy width=500 height=327> </a> <figcaption class=md-typeset> <h2>Social cards</h2> <p> <strong>Make an impact on social media</strong> and <strong>increase engagement</strong> when sharing links to your documentation by leveraging the built-in social plugin. Material for MkDocs makes it effortless to generate a <strong>beautiful preview image</strong> for each page, which will drive more interested users to your Open Source or commercial project. </p> <p> While the social plugin uses what's already there, i.e. your project's name and logo, as well as each page's title and description, it's easy to <strong>customize preview images</strong>. </p> <a href=setup/setting-up-social-cards/ aria-label="Social cards"> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg> </span> Learn more </a> </p> </figcaption> </figure> <figure class=mdx-spotlight__feature hidden> <a href=reference/icons-emojis/#search tabindex=-1 title="10,000+ icons and emojis"> <img src=assets/images/spotlight/icons-emojis.png alt="10,000+ icons and emojis" loading=lazy width=500 height=327> </a> <figcaption class=md-typeset> <h2> 10,000+ icons and emojis <img class=twemoji src=https://cdnjs.cloudflare.com/ajax/libs/twemoji/14.0.2/svg/1f604.svg alt=Tada> </h2> <p> Supercharge your technical writing by making better use of the processing power of the visual cortex: Material for MkDocs ships <strong>more than 10,000 icons and emojis</strong>, which can be used <strong>in Markdown and HTML</strong> with simple shortcodes and an easy-to-remember syntax. Add color to icons and animate them. <strong>Make it pop.</strong> </p> <p> Use our dedicated <a href=reference/icons-emojis/#search>icon search</a> to quickly find the perfect icon for almost every use case and <strong>add custom icon sets</strong> with minimal configuration. </p> <a href=reference/icons-emojis/#search aria-label="10,000+ icons and emojis"> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.22 19.03a.75.75 0 0 1 0-1.06L18.19 13H3.75a.75.75 0 0 1 0-1.5h14.44l-4.97-4.97a.749.749 0 0 1 .326-1.275.75.75 0 0 1 .734.215l6.25 6.25a.75.75 0 0 1 0 1.06l-6.25 6.25a.75.75 0 0 1-1.06 0"/></svg> </span> Learn more </a> </p> </figcaption> </figure> </div> </div> </div> </section> <section class=mdx-parallax__group data-md-color-scheme=slate data-md-color-primary=indigo> <img src=assets/images/wall.png alt="Trusted in the industry" class=mdx-parallax__image width=3840 height=1200> <div class="md-content md-grid" data-md-component=content> <div class=md-content__inner> <header class=md-typeset hidden> <h1 id=trusted-in-the-industry> Trusted in the industry <a href=#trusted-in-the-industry class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class="mdx-trust md-typeset" hidden> <h3> Industry leaders, as well as many successful Open Source projects, rely on Material for MkDocs to create professional and beautiful documentation – <strong>no frontend experience required</strong>. Choose a mature and actively maintained solution and <strong>start writing in minutes</strong>. </h3> <p> <a href=getting-started class=md-button> Get started </a> </p> </div> </div> </div> </section> <section class=mdx-parallax__group data-md-color-scheme=default> <div class="md-content md-grid" data-md-component=content> <div class=md-content__inner> <header class=md-typeset hidden> <h1 id=what-our-users-say> What our users say <a href=#what-our-users-say class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class=mdx-users> <figure class=mdx-users__testimonial hidden> <img src=assets/images/users/john-maeda.jpg alt="John Maeda" loading=lazy width=200 height=200> <figcaption class=md-typeset> <h2>John Maeda</h2> <h3> Author / <a href=https://howtospeakmachine.com/ >How To Speak Machine</a> </h3> <hr> <cite> The unwritten rule of the digital transformation handbook is that you'll never have the resources to design experiences like Apple. But you can always close most usability gaps with an awesome documentation experience. Expressed similarly in <a href=https://mitpress.mit.edu/books/laws-simplicity>The Laws of Simplicity</a>, "Learning makes things simpler". Material for MkDocs is the magical, extensible, Open Source tool that makes sharing knowledge both easier and beautiful for both the writers and learners. </cite> </figcaption> </figure> <figure class=mdx-users__testimonial hidden> <img src=assets/images/users/sebastian-ramirez.jpg alt="Sebastián Ramírez" loading=lazy width=200 height=200> <figcaption class=md-typeset> <h2>Sebastián Ramírez</h2> <h3> Creator of <a href=https://fastapi.tiangolo.com/ >FastAPI</a>, <a href=https://typer.tiangolo.com/ >Typer</a> & <a href=https://sqlmodel.tiangolo.com/ >SQLModel</a> </h3> <hr> <cite> One of the things people like the most about FastAPI, Typer, and SQLModel, is the documentation. I have put a lot of effort into making it easy to study and fast to understand. And a key component of that is the richness of ways I can explain and show things with Material for MkDocs. It's so easy to structure and explain things using it with all its features! It's simple to use, immersive for visitors, and beautiful by default. </cite> </figcaption> </figure> <figure class=mdx-users__testimonial hidden> <img src=assets/images/users/michael-feng.jpg alt="Michael Feng" loading=lazy width=200 height=200> <figcaption class=md-typeset> <h2>Michael Feng</h2> <h3> Co-Founder & CEO of <a href=https://hummingbot.com>Hummingbot</a> </h3> <hr> <cite> Hummingbot Foundation depends on Material for MkDocs for our official website and documentation at <a href=https://hummingbot.org>hummingbot.org</a>. We find it ideal for a complex documentation site because of the flexible navigation and layout options and built-in search. </cite> </figcaption> </figure> </div> </div> </div> </section> <section class=mdx-parallax__group data-md-color-scheme=slate data-md-color-primary=indigo> <div class="md-content md-grid" data-md-component=content> <div class="md-content__inner mdx-content__inner"> <div class=mdx-content__column> <header class=md-typeset hidden> <h1 id=become-a-sponsor> Become a sponsor <a href=#become-a-sponsor class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class="mdx-connect md-typeset" hidden> <div class=mdx-connect__column> <p> By joining the <a href=insiders/ >Insiders</a> program, you'll get immediate access to the latest features while also helping support the ongoing development of Material for MkDocs. Thanks to our <a href=insiders/#how-to-become-a-sponsor>awesome sponsors</a>, this project is actively maintained and kept in good shape. </p> <p> <strong> Together, we can build documentation that simply works! </strong> </p> <p> <a href=insiders/ class=md-button aria-label=Insiders> Learn more </a> </p> </div> </div> </div> <div class=mdx-content__column> <header class=md-typeset hidden> <h1 id=keep-in-touch> Let's keep in touch <a href=#keep-in-touch class=headerlink title="Permanent link"> ¶ </a> </h1> </header> <div class="mdx-connect md-typeset" hidden> <div class=mdx-connect__inner> <p> <a href=https://twitter.com/@squidfunk class=mdx-connect__link> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"/></svg> </span> Follow <strong>@squidfunk</strong> on <strong>Twitter</strong> </a> <a href=https://fosstodon.org/@squidfunk class=mdx-connect__link> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M433 179.11c0-97.2-63.71-125.7-63.71-125.7-62.52-28.7-228.56-28.4-290.48 0 0 0-63.72 28.5-63.72 125.7 0 115.7-6.6 259.4 105.63 289.1 40.51 10.7 75.32 13 103.33 11.4 50.81-2.8 79.32-18.1 79.32-18.1l-1.7-36.9s-36.31 11.4-77.12 10.1c-40.41-1.4-83-4.4-89.63-54a102.5 102.5 0 0 1-.9-13.9c85.63 20.9 158.65 9.1 178.75 6.7 56.12-6.7 105-41.3 111.23-72.9 9.8-49.8 9-121.5 9-121.5m-75.12 125.2h-46.63v-114.2c0-49.7-64-51.6-64 6.9v62.5h-46.33V197c0-58.5-64-56.6-64-6.9v114.2H90.19c0-122.1-5.2-147.9 18.41-175 25.9-28.9 79.82-30.8 103.83 6.1l11.6 19.5 11.6-19.5c24.11-37.1 78.12-34.8 103.83-6.1 23.71 27.3 18.4 53 18.4 175z"/></svg> </span> Follow <strong>@squidfunk</strong> on <strong>Fosstodon</strong> </a> </p> <p> <a href=https://github.com/squidfunk/mkdocs-material class=mdx-connect__link> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </span> Material for MkDocs on <strong>GitHub</strong> </a> <a href=https://hub.docker.com/r/squidfunk/mkdocs-material class=mdx-connect__link> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 640 512"><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"/></svg> </span> Material for MkDocs on <strong>DockerHub</strong> </a> <a href=https://pypi.org/project/mkdocs-material class=mdx-connect__link> <span class=twemoji> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6M286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3M167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4m-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3"/></svg> </span> Material for MkDocs on <strong>PyPI</strong> </a> </p> </div> </div> </div> </div> </section> <div class=mdx-parallax__group data-md-color-scheme=slate> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=getting-started/ class="md-footer__link md-footer__link--next" aria-label="Next: Installation"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Installation </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © 2016 - 2025 Martin Donath </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs Insiders </a> </div> <div class=md-social> <a href=https://github.com/squidfunk target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> <a href=https://hub.docker.com/r/squidfunk/mkdocs-material/ target=_blank rel=noopener title=hub.docker.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 640 512"><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"/></svg> </a> <a href=https://pypi.org/project/mkdocs-material/ target=_blank rel=noopener title=pypi.org class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6M286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3M167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4m-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3"/></svg> </a> <a href=https://bsky.app/profile/squidfunk.com target=_blank rel=noopener title=bsky.app class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><path d="M111.8 62.2C170.2 105.9 233 194.7 256 242.4c23-47.6 85.8-136.4 144.2-180.2 42.1-31.6 110.3-56 110.3 21.8 0 15.5-8.9 130.5-14.1 149.2-18.2 64.8-84.4 81.4-143.3 71.3C456 322 482.2 380 425.6 438c-107.4 110.2-154.3-27.6-166.3-62.9-1.7-4.9-2.6-7.8-3.3-7.8s-1.6 3-3.3 7.8c-12 35.3-59 173.1-166.3 62.9-56.5-58-30.4-116 72.5-133.5C100 314.6 33.8 298 15.7 233.1 10.4 214.4 1.5 99.4 1.5 83.9c0-77.8 68.2-53.4 110.3-21.8z"/></svg> </a> <a href=https://fosstodon.org/@squidfunk target=_blank rel="noopener me" title=fosstodon.org class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M433 179.11c0-97.2-63.71-125.7-63.71-125.7-62.52-28.7-228.56-28.4-290.48 0 0 0-63.72 28.5-63.72 125.7 0 115.7-6.6 259.4 105.63 289.1 40.51 10.7 75.32 13 103.33 11.4 50.81-2.8 79.32-18.1 79.32-18.1l-1.7-36.9s-36.31 11.4-77.12 10.1c-40.41-1.4-83-4.4-89.63-54a102.5 102.5 0 0 1-.9-13.9c85.63 20.9 158.65 9.1 178.75 6.7 56.12-6.7 105-41.3 111.23-72.9 9.8-49.8 9-121.5 9-121.5m-75.12 125.2h-46.63v-114.2c0-49.7-64-51.6-64 6.9v62.5h-46.33V197c0-58.5-64-56.6-64-6.9v114.2H90.19c0-122.1-5.2-147.9 18.41-175 25.9-28.9 79.82-30.8 103.83 6.1l11.6 19.5 11.6-19.5c24.11-37.1 78.12-34.8 103.83-6.1 23.71 27.3 18.4 53 18.4 175z"/></svg> </a> <a href=https://x.com/squidfunk target=_blank rel=noopener title=x.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><path d="M389.2 48h70.6L305.6 224.2 487 464H345L233.7 318.6 106.5 464H35.8l164.9-188.5L26.8 48h145.6l100.5 132.9zm-24.8 373.8h39.1L151.1 88h-42z"/></svg> </a> </div> </div> </div> </footer> </div> </div> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=. title="Material for MkDocs" class="md-nav__button md-logo" aria-label="Material for MkDocs" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 89 89"> <path d=M3.136,17.387l0,42.932l42.932,21.467l-42.932,-64.399Z /> <path d=M21.91,8l42.933,64.398l-18.775,9.388l-42.932,-64.399l18.774,-9.387Z style="fill-opacity: 0.5"/> <path d=M67.535,17.387l-27.262,18.156l21.878,32.818l5.384,2.691l0,-53.665Z /> <path d=M67.535,17.387l0,53.666l18.774,-9.388l0,-53.665l-18.774,9.387Z style="fill-opacity: 0.25"/> </svg> </a> Material for MkDocs </label> <div class=md-nav__source> <a href=https://github.com/squidfunk/mkdocs-material title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class=md-source__repository> squidfunk/mkdocs-material </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <a href=. class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Home </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Getting started </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Getting started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=getting-started/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=creating-your-site/ class=md-nav__link> <span class=md-ellipsis> Creating your site </span> </a> </li> <li class=md-nav__item> <a href=publishing-your-site/ class=md-nav__link> <span class=md-ellipsis> Publishing your site </span> </a> </li> <li class=md-nav__item> <a href=customization/ class=md-nav__link> <span class=md-ellipsis> Customization </span> </a> </li> <li class=md-nav__item> <a href=conventions/ class=md-nav__link> <span class=md-ellipsis> Conventions </span> </a> </li> <li class=md-nav__item> <a href=browser-support/ class=md-nav__link> <span class=md-ellipsis> Browser support </span> </a> </li> <li class=md-nav__item> <a href=enterprise-support/ class=md-nav__link> <span class=md-ellipsis> Enterprise feedback </span> <span class="md-status md-status--new" title="Recently added"> </span> </a> </li> <li class=md-nav__item> <a href=philosophy/ class=md-nav__link> <span class=md-ellipsis> Philosophy </span> </a> </li> <li class=md-nav__item> <a href=alternatives/ class=md-nav__link> <span class=md-ellipsis> Alternatives </span> </a> </li> <li class=md-nav__item> <a href=license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_11> <div class="md-nav__link md-nav__container"> <a href=tutorials/ class="md-nav__link "> <span class=md-ellipsis> Tutorials </span> </a> <label class="md-nav__link " for=__nav_2_11 id=__nav_2_11_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_11_label aria-expanded=false> <label class=md-nav__title for=__nav_2_11> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_11_2> <label class=md-nav__link for=__nav_2_11_2 id=__nav_2_11_2_label tabindex=0> <span class=md-ellipsis> Blogs </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_2_11_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2_11_2> <span class="md-nav__icon md-icon"></span> Blogs </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=tutorials/blogs/basic/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Basic blogs </span> </span> </a> </li> <li class=md-nav__item> <a href=tutorials/blogs/navigation/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Navigation, authors, and pagination </span> </span> </a> </li> <li class=md-nav__item> <a href=tutorials/blogs/engage/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Engagement and dissemination </span> </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_11_3> <label class=md-nav__link for=__nav_2_11_3 id=__nav_2_11_3_label tabindex=0> <span class=md-ellipsis> Social cards </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=3 aria-labelledby=__nav_2_11_3_label aria-expanded=false> <label class=md-nav__title for=__nav_2_11_3> <span class="md-nav__icon md-icon"></span> Social cards </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=tutorials/social/basic/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Basic social cards </span> </span> </a> </li> <li class=md-nav__item> <a href=tutorials/social/custom/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Custom cards </span> </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2_12> <div class="md-nav__link md-nav__container"> <a href=changelog/ class="md-nav__link "> <span class=md-ellipsis> Changelog </span> </a> <label class="md-nav__link " for=__nav_2_12 id=__nav_2_12_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_12_label aria-expanded=false> <label class=md-nav__title for=__nav_2_12> <span class="md-nav__icon md-icon"></span> Changelog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=upgrade/ class=md-nav__link> <span class=md-ellipsis> How to upgrade </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3> <div class="md-nav__link md-nav__container"> <a href=setup/ class="md-nav__link "> <span class=md-ellipsis> Setup </span> </a> <label class="md-nav__link " for=__nav_3 id=__nav_3_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Setup </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=setup/changing-the-colors/ class=md-nav__link> <span class=md-ellipsis> Changing the colors </span> </a> </li> <li class=md-nav__item> <a href=setup/changing-the-fonts/ class=md-nav__link> <span class=md-ellipsis> Changing the fonts </span> </a> </li> <li class=md-nav__item> <a href=setup/changing-the-language/ class=md-nav__link> <span class=md-ellipsis> Changing the language </span> </a> </li> <li class=md-nav__item> <a href=setup/changing-the-logo-and-icons/ class=md-nav__link> <span class=md-ellipsis> Changing the logo and icons </span> </a> </li> <li class=md-nav__item> <a href=setup/ensuring-data-privacy/ class=md-nav__link> <span class=md-ellipsis> Ensuring data privacy </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-navigation/ class=md-nav__link> <span class=md-ellipsis> Setting up navigation </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-site-search/ class=md-nav__link> <span class=md-ellipsis> Setting up site search </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-site-analytics/ class=md-nav__link> <span class=md-ellipsis> Setting up site analytics </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-social-cards/ class=md-nav__link> <span class=md-ellipsis> Setting up social cards </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-a-blog/ class=md-nav__link> <span class=md-ellipsis> Setting up a blog </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-tags/ class=md-nav__link> <span class=md-ellipsis> Setting up tags </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-versioning/ class=md-nav__link> <span class=md-ellipsis> Setting up versioning </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-the-header/ class=md-nav__link> <span class=md-ellipsis> Setting up the header </span> </a> </li> <li class=md-nav__item> <a href=setup/setting-up-the-footer/ class=md-nav__link> <span class=md-ellipsis> Setting up the footer </span> </a> </li> <li class=md-nav__item> <a href=setup/adding-a-git-repository/ class=md-nav__link> <span class=md-ellipsis> Adding a git repository </span> </a> </li> <li class=md-nav__item> <a href=setup/adding-a-comment-system/ class=md-nav__link> <span class=md-ellipsis> Adding a comment system </span> </a> </li> <li class=md-nav__item> <a href=setup/building-an-optimized-site/ class=md-nav__link> <span class=md-ellipsis> Building an optimized site </span> </a> </li> <li class=md-nav__item> <a href=setup/building-for-offline-usage/ class=md-nav__link> <span class=md-ellipsis> Building for offline usage </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_20> <div class="md-nav__link md-nav__container"> <a href=setup/extensions/ class="md-nav__link "> <span class=md-ellipsis> Extensions </span> </a> <label class="md-nav__link " for=__nav_3_20 id=__nav_3_20_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_20_label aria-expanded=false> <label class=md-nav__title for=__nav_3_20> <span class="md-nav__icon md-icon"></span> Extensions </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=setup/extensions/python-markdown/ class=md-nav__link> <span class=md-ellipsis> Python Markdown </span> </a> </li> <li class=md-nav__item> <a href=setup/extensions/python-markdown-extensions/ class=md-nav__link> <span class=md-ellipsis> Python Markdown Extensions </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4> <div class="md-nav__link md-nav__container"> <a href=plugins/ class="md-nav__link "> <span class=md-ellipsis> Plugins </span> </a> <label class="md-nav__link " for=__nav_4 id=__nav_4_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=plugins/blog/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 5v14H4V5zm0-2H4c-1.11 0-2 .89-2 2v14c0 1.11.89 2 2 2h16c1.11 0 2-.89 2-2V5c0-1.11-.89-2-2-2m-2 12H6v2h12zm-8-8H6v6h4zm2 2h6V7h-6zm6 2h-6v2h6z"/></svg> <span class=md-ellipsis> Blog </span> </a> </li> <li class=md-nav__item> <a href=plugins/group/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 5v14h2v2H3V3h4v2zm15 2H7v2h13zm0 4H7v2h13zm0 4H7v2h13z"/></svg> <span class=md-ellipsis> Group </span> </a> </li> <li class=md-nav__item> <a href=plugins/info/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg> <span class=md-ellipsis> Info </span> </a> </li> <li class=md-nav__item> <a href=plugins/meta/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 3h6v4H3zm12 7h6v4h-6zm0 7h6v4h-6zm-2-4H7v5h6v2H5V9h2v2h6z"/></svg> <span class=md-ellipsis> Meta </span> </a> </li> <li class=md-nav__item> <a href=plugins/offline/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21.4 7.5c.8.8.8 2.1 0 2.8l-2.8 2.8-7.8-7.8 2.8-2.8c.8-.8 2.1-.8 2.8 0l1.8 1.8 3-3 1.4 1.4-3 3zm-5.8 5.8-1.4-1.4-2.8 2.8-2.1-2.1 2.8-2.8-1.4-1.4-2.8 2.8-1.5-1.4-2.8 2.8c-.8.8-.8 2.1 0 2.8l1.8 1.8-4 4 1.4 1.4 4-4 1.8 1.8c.8.8 2.1.8 2.8 0l2.8-2.8-1.4-1.4z"/></svg> <span class=md-ellipsis> Offline </span> </a> </li> <li class=md-nav__item> <a href=plugins/optimize/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m18.05 21-2.73-4.74c0-1.73-1.07-2.84-2.37-2.84-.9 0-1.68.5-2.08 1.24.33-.19.72-.29 1.13-.29 1.3 0 2.36 1.06 2.36 2.36 0 1.31-1.05 2.38-2.36 2.38h3.3V21H6.79c-.24 0-.49-.09-.67-.28a.95.95 0 0 1 0-1.34l.5-.5c-.34-.15-.62-.38-.9-.62-.22.5-.72.85-1.3.85a1.425 1.425 0 0 1 0-2.85l.47.08v-1.97a4.73 4.73 0 0 1 4.74-4.74h.02c2.12.01 3.77.84 3.77-.47 0-.93.2-1.3.54-1.82-.73-.34-1.56-.55-2.43-.55-.53 0-.95-.42-.95-.95 0-.43.28-.79.67-.91l-.67-.04c-.52 0-.95-.42-.95-.94 0-.53.43-.95.95-.95h.95c2.1 0 3.94 1.15 4.93 2.85l.28-.01c.71 0 1.37.23 1.91.61l.45.38c2.17 1.95 1.9 3.27 1.9 3.28 0 1.28-1.06 2.33-2.35 2.33l-.49-.05v.08c0 1.11-.48 2.1-1.23 2.8L20.24 21zm.11-13.26c-.53 0-.95.42-.95.94 0 .53.42.95.95.95.52 0 .95-.42.95-.95 0-.52-.43-.94-.95-.94"/></svg> <span class=md-ellipsis> Optimize </span> </a> </li> <li class=md-nav__item> <a href=plugins/privacy/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 1 3 5v6c0 5.55 3.84 10.74 9 12 5.16-1.26 9-6.45 9-12V5zm0 4a3 3 0 0 1 3 3 3 3 0 0 1-3 3 3 3 0 0 1-3-3 3 3 0 0 1 3-3m5.13 12A9.7 9.7 0 0 1 12 20.92 9.7 9.7 0 0 1 6.87 17c-.34-.5-.63-1-.87-1.53 0-1.65 2.71-3 6-3s6 1.32 6 3c-.24.53-.53 1.03-.87 1.53"/></svg> <span class=md-ellipsis> Privacy </span> </a> </li> <li class=md-nav__item> <a href=plugins/projects/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 20H4a2 2 0 0 1-2-2V6c0-1.11.89-2 2-2h6l2 2h7a2 2 0 0 1 2 2H4v10l2.14-8h17.07l-2.28 8.5c-.23.87-1.01 1.5-1.93 1.5"/></svg> <span class=md-ellipsis> Projects </span> </a> </li> <li class=md-nav__item> <a href=plugins/search/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <span class=md-ellipsis> Search </span> </a> </li> <li class=md-nav__item> <a href=plugins/social/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2C6.5 2 2 6.5 2 12s4.5 10 10 10 10-4.5 10-10S17.5 2 12 2m2 14v-3c-3.61 0-6.19 1.43-8 4 .72-3.67 2.94-7.27 8-8V6l5 5z"/></svg> <span class=md-ellipsis> Social </span> </a> </li> <li class=md-nav__item> <a href=plugins/tags/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m21.41 11.58-9-9A2 2 0 0 0 11 2H4a2 2 0 0 0-2 2v7a2 2 0 0 0 .59 1.41l9 9A2 2 0 0 0 13 22a2 2 0 0 0 1.41-.59l7-7A2 2 0 0 0 22 13a2 2 0 0 0-.59-1.42M6.5 8A1.5 1.5 0 1 1 8 6.5 1.5 1.5 0 0 1 6.5 8m5.09 7.41-4-4L9 10l4 4m2.59.41-5.5-5.5L11.5 7.5 17 13Z"/></svg> <span class=md-ellipsis> Tags </span> </a> </li> <li class=md-nav__item> <a href=plugins/typeset/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 4v3h5.5v12h3V7H19V4z"/></svg> <span class=md-ellipsis> Typeset </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4_14> <label class=md-nav__link for=__nav_4_14 id=__nav_4_14_label tabindex=0> <span class=md-ellipsis> Requirements </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_14_label aria-expanded=false> <label class=md-nav__title for=__nav_4_14> <span class="md-nav__icon md-icon"></span> Requirements </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=plugins/requirements/image-processing/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13.18 19c.17.72.46 1.39.85 2H5a2 2 0 0 1-2-2V5c0-1.1.9-2 2-2h14a2 2 0 0 1 2 2v6.18c-.5-.11-1-.18-1.5-.18-.17 0-.33 0-.5.03V5H5v14zm-1.97-3.17-1.96-2.36L6.5 17h6.53c.11-1.46.7-2.78 1.61-3.81l-.68-.9zM19 13.5V12l-2.25 2.25L19 16.5V15a2.5 2.5 0 0 1 2.5 2.5c0 .4-.09.78-.26 1.12l1.09 1.09c.42-.63.67-1.39.67-2.21 0-2.21-1.79-4-4-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5c0-.4.09-.78.26-1.12l-1.09-1.09c-.42.63-.67 1.39-.67 2.21 0 2.21 1.79 4 4 4V23l2.25-2.25L19 18.5z"/></svg> <span class=md-ellipsis> Image processing </span> </a> </li> <li class=md-nav__item> <a href=plugins/requirements/caching/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 3C7.58 3 4 4.79 4 7v10c0 2.21 3.59 4 8 4s8-1.79 8-4V7c0-2.21-3.58-4-8-4m6 14c0 .5-2.13 2-6 2s-6-1.5-6-2v-2.23c1.61.78 3.72 1.23 6 1.23s4.39-.45 6-1.23zm0-4.55c-1.3.95-3.58 1.55-6 1.55s-4.7-.6-6-1.55V9.64c1.47.83 3.61 1.36 6 1.36s4.53-.53 6-1.36zM12 9C8.13 9 6 7.5 6 7s2.13-2 6-2 6 1.5 6 2-2.13 2-6 2"/></svg> <span class=md-ellipsis> Caching </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_5> <div class="md-nav__link md-nav__container"> <a href=reference/ class="md-nav__link "> <span class=md-ellipsis> Reference </span> </a> <label class="md-nav__link " for=__nav_5 id=__nav_5_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=reference/admonitions/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2 1 21h22M12 6l7.53 13H4.47M11 10v4h2v-4m-2 6v2h2v-2"/></svg> <span class=md-ellipsis> Admonitions </span> </a> </li> <li class=md-nav__item> <a href=reference/annotations/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 13h-4v4h-2v-4H7v-2h4V7h2v4h4m-5-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg> <span class=md-ellipsis> Annotations </span> </a> </li> <li class=md-nav__item> <a href=reference/buttons/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18.1 15.3c-.1.1-.3.2-.4.3l-2.4.4 1.7 3.6c.2.4 0 .8-.4 1l-2.8 1.3c-.1.1-.2.1-.3.1-.3 0-.6-.2-.7-.4L11.2 18l-1.9 1.5c-.1.1-.3.2-.5.2-.4 0-.8-.3-.8-.8V7.5c0-.5.3-.8.8-.8.2 0 .4.1.5.2l8.7 7.4c.3.2.4.7.1 1M6 12H4V4h16v8h-1.6l2.2 1.9c.8-.3 1.3-1 1.3-1.9V4c0-1.1-.9-2-2-2H4c-1.1 0-2 .9-2 2v8c0 1.1.9 2 2 2h2z"/></svg> <span class=md-ellipsis> Buttons </span> </a> </li> <li class=md-nav__item> <a href=reference/code-blocks/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M5 3h2v2H5v5a2 2 0 0 1-2 2 2 2 0 0 1 2 2v5h2v2H5c-1.07-.27-2-.9-2-2v-4a2 2 0 0 0-2-2H0v-2h1a2 2 0 0 0 2-2V5a2 2 0 0 1 2-2m14 0a2 2 0 0 1 2 2v4a2 2 0 0 0 2 2h1v2h-1a2 2 0 0 0-2 2v4a2 2 0 0 1-2 2h-2v-2h2v-5a2 2 0 0 1 2-2 2 2 0 0 1-2-2V5h-2V3zm-7 12a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m-4 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1m8 0a1 1 0 0 1 1 1 1 1 0 0 1-1 1 1 1 0 0 1-1-1 1 1 0 0 1 1-1"/></svg> <span class=md-ellipsis> Code blocks </span> </a> </li> <li class=md-nav__item> <a href=reference/content-tabs/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 3H3a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h18a2 2 0 0 0 2-2V5a2 2 0 0 0-2-2m0 16H3V5h10v4h8z"/></svg> <span class=md-ellipsis> Content tabs </span> </a> </li> <li class=md-nav__item> <a href=reference/data-tables/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m21.7 13.35-1 1-2.05-2.05 1-1c.21-.22.56-.22.77 0l1.28 1.28c.22.21.22.56 0 .77M12 18.94l6.07-6.06 2.05 2.05L14.06 21H12zM4 2h14a2 2 0 0 1 2 2v4.17L16.17 12H12v4.17L10.17 18H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 4v4h6V6zm8 0v4h6V6zm-8 6v4h6v-4z"/></svg> <span class=md-ellipsis> Data tables </span> </a> </li> <li class=md-nav__item> <a href=reference/diagrams/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 17c-.14 0-.26 0-.39.04L17.5 13.8c.45-.45.75-1.09.75-1.8a2.5 2.5 0 0 0-2.5-2.5c-.14 0-.25 0-.4.04L13.74 6.3c.47-.46.76-1.09.76-1.8a2.5 2.5 0 0 0-5 0c0 .7.29 1.34.76 1.79L8.65 9.54c-.15-.04-.26-.04-.4-.04a2.5 2.5 0 0 0-2.5 2.5c0 .71.29 1.34.75 1.79l-1.61 3.25C4.76 17 4.64 17 4.5 17a2.5 2.5 0 0 0 0 5A2.5 2.5 0 0 0 7 19.5c0-.7-.29-1.34-.76-1.79l1.62-3.25c.14.04.26.04.39.04s.25 0 .38-.04l1.63 3.25c-.47.45-.76 1.09-.76 1.79a2.5 2.5 0 0 0 5 0A2.5 2.5 0 0 0 12 17c-.13 0-.26 0-.39.04L10 13.8c.45-.45.75-1.09.75-1.8 0-.7-.29-1.33-.75-1.79l1.61-3.25c.13.04.26.04.39.04s.26 0 .39-.04L14 10.21a2.5 2.5 0 0 0 1.75 4.29c.13 0 .25 0 .38-.04l1.63 3.25c-.47.45-.76 1.09-.76 1.79a2.5 2.5 0 0 0 5 0 2.5 2.5 0 0 0-2.5-2.5m-15 3.5c-.55 0-1-.45-1-1s.45-1 1-1 1 .45 1 1-.45 1-1 1m8.5-1c0 .55-.45 1-1 1s-1-.45-1-1 .45-1 1-1 1 .45 1 1M7.25 12c0-.55.45-1 1-1s1 .45 1 1-.45 1-1 1-1-.45-1-1M11 4.5c0-.55.45-1 1-1s1 .45 1 1-.45 1-1 1-1-.45-1-1m3.75 7.5c0-.55.45-1 1-1s1 .45 1 1-.45 1-1 1-1-.45-1-1m4.75 8.5c-.55 0-1-.45-1-1s.45-1 1-1 1 .45 1 1-.45 1-1 1"/></svg> <span class=md-ellipsis> Diagrams </span> </a> </li> <li class=md-nav__item> <a href=reference/footnotes/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m13 9 2.5-2.5 1.42 1.42L12 12.84 7.08 7.92 8.5 6.5 11 9V3h2zM3 15h18v2H3zm0 4h10v2H3z"/></svg> <span class=md-ellipsis> Footnotes </span> </a> </li> <li class=md-nav__item> <a href=reference/formatting/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M17 8h3v12h1v1h-4v-1h1v-3h-4l-1.5 3H14v1h-4v-1h1zm1 1-3.5 7H18zM5 3h5c1.11 0 2 .89 2 2v11H9v-5H6v5H3V5c0-1.11.89-2 2-2m1 2v4h3V5z"/></svg> <span class=md-ellipsis> Formatting </span> </a> </li> <li class=md-nav__item> <a href=reference/grids/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 3v8h8V3zM3 21h8v-8H3zM3 3v8h8V3zm10 13h3v-3h2v3h3v2h-3v3h-2v-3h-3z"/></svg> <span class=md-ellipsis> Grids </span> </a> </li> <li class=md-nav__item> <a href=reference/icons-emojis/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg> <span class=md-ellipsis> Icons, Emojis </span> </a> </li> <li class=md-nav__item> <a href=reference/images/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 14.29 6.5 19h10.96l-2.71-3.54-1.97 2.34zM5 21V7h13.96v14zm7-18.6 2.61 2.63H9.37zM5 5.03c-.5 0-1 .19-1.39.58C3.2 6 3 6.46 3 7v14c0 .5.2 1 .61 1.39C4 22.8 4.5 23 5 23h13.96c.54 0 1-.2 1.41-.61.4-.39.63-.89.63-1.39V7c0-.54-.23-1-.63-1.39-.41-.39-.87-.58-1.41-.58H16L12 1 7.96 5.03z"/></svg> <span class=md-ellipsis> Images </span> </a> </li> <li class=md-nav__item> <a href=reference/lists/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M7 5h14v2H7zm0 8v-2h14v2zM4 4.5A1.5 1.5 0 0 1 5.5 6 1.5 1.5 0 0 1 4 7.5 1.5 1.5 0 0 1 2.5 6 1.5 1.5 0 0 1 4 4.5m0 6A1.5 1.5 0 0 1 5.5 12 1.5 1.5 0 0 1 4 13.5 1.5 1.5 0 0 1 2.5 12 1.5 1.5 0 0 1 4 10.5M7 19v-2h14v2zm-3-2.5A1.5 1.5 0 0 1 5.5 18 1.5 1.5 0 0 1 4 19.5 1.5 1.5 0 0 1 2.5 18 1.5 1.5 0 0 1 4 16.5"/></svg> <span class=md-ellipsis> Lists </span> </a> </li> <li class=md-nav__item> <a href=reference/math/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M16 6c-1.64 0-3 1.36-3 3v12h2V9c0-.57.43-1 1-1h1c.57 0 1 .43 1 1v1c0 .57-.43 1-1 1h-1v2h1c.57 0 1 .43 1 1v1c0 .57-.43 1-1 1h-1v2h1c1.65 0 3-1.35 3-3v-1c0-.82-.41-1.54-1-2 .59-.46 1-1.18 1-2V9c0-1.64-1.35-3-3-3M7 9c-1.64 0-3 1.36-3 3v3c0 1.65 1.36 3 3 3h.7c.5 0 .95-.19 1.3-.5v.5h2V9H9v.5c-.35-.31-.8-.5-1.3-.5M7 11h1c.57 0 1 .43 1 1v3c0 .57-.43 1-1 1H7c-.57 0-1-.43-1-1v-3c0-.57.43-1 1-1"/></svg> <span class=md-ellipsis> Math </span> </a> </li> <li class=md-nav__item> <a href=reference/tooltips/ class=md-nav__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 2h16a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2h-4l-4 4-4-4H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m7 4v3H8v2h3v3h2v-3h3V9h-3V6z"/></svg> <span class=md-ellipsis> Tooltips </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_6> <div class="md-nav__link md-nav__container"> <a href=insiders/ class="md-nav__link "> <span class=md-ellipsis> Insiders </span> </a> <label class="md-nav__link " for=__nav_6 id=__nav_6_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Insiders </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=insiders/why-sponsor-us/ class=md-nav__link> <span class=md-ellipsis> Why sponsor us </span> </a> </li> <li class=md-nav__item> <a href=insiders/benefits/ class=md-nav__link> <span class=md-ellipsis> What's in it for you </span> </a> </li> <li class=md-nav__item> <a href=insiders/our-sponsors/ class=md-nav__link> <span class=md-ellipsis> Who is sponsoring </span> </a> </li> <li class=md-nav__item> <a href=insiders/sponsoring-tiers/ class=md-nav__link> <span class=md-ellipsis> Sponsoring tiers </span> </a> </li> <li class=md-nav__item> <a href=insiders/how-to-sponsor/ class=md-nav__link> <span class=md-ellipsis> How to sponsor </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_6_7> <label class=md-nav__link for=__nav_6_7 id=__nav_6_7_label tabindex=0> <span class=md-ellipsis> Additional information </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_7_label aria-expanded=false> <label class=md-nav__title for=__nav_6_7> <span class="md-nav__icon md-icon"></span> Additional information </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=insiders/payment-and-billing/ class=md-nav__link> <span class=md-ellipsis> Payment and billing </span> </a> </li> <li class=md-nav__item> <a href=insiders/access-management/ class=md-nav__link> <span class=md-ellipsis> Access management </span> </a> </li> <li class=md-nav__item> <a href=insiders/runtime-and-cancellation/ class=md-nav__link> <span class=md-ellipsis> Runtime and cancellation </span> </a> </li> <li class=md-nav__item> <a href=insiders/privacy/ class=md-nav__link> <span class=md-ellipsis> Privacy </span> </a> </li> <li class=md-nav__item> <a href=insiders/license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> <li class=md-nav__item> <a href=support/ class=md-nav__link> <span class=md-ellipsis> Support </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_6_8> <label class=md-nav__link for=__nav_6_8 id=__nav_6_8_label tabindex=0> <span class=md-ellipsis> Using Insiders </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_8_label aria-expanded=false> <label class=md-nav__title for=__nav_6_8> <span class="md-nav__icon md-icon"></span> Using Insiders </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=insiders/getting-started/ class=md-nav__link> <span class=md-ellipsis> Getting started </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_6_9> <div class="md-nav__link md-nav__container"> <a href=insiders/changelog/ class="md-nav__link "> <span class=md-ellipsis> Changelog </span> </a> <label class="md-nav__link " for=__nav_6_9 id=__nav_6_9_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_9_label aria-expanded=false> <label class=md-nav__title for=__nav_6_9> <span class="md-nav__icon md-icon"></span> Changelog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=insiders/upgrade/ class=md-nav__link> <span class=md-ellipsis> How to upgrade </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Community </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Community </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_7_1> <div class="md-nav__link md-nav__container"> <a href=contributing/ class="md-nav__link "> <span class=md-ellipsis> Contributing </span> </a> <label class="md-nav__link " for=__nav_7_1 id=__nav_7_1_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_7_1_label aria-expanded=false> <label class=md-nav__title for=__nav_7_1> <span class="md-nav__icon md-icon"></span> Contributing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=contributing/reporting-a-bug/ class=md-nav__link> <span class=md-ellipsis> Reporting a bug </span> </a> </li> <li class=md-nav__item> <a href=contributing/reporting-a-docs-issue/ class=md-nav__link> <span class=md-ellipsis> Reporting a docs issue </span> </a> </li> <li class=md-nav__item> <a href=contributing/requesting-a-change/ class=md-nav__link> <span class=md-ellipsis> Requesting a change </span> </a> </li> <li class=md-nav__item> <a href=contributing/adding-translations/ class=md-nav__link> <span class=md-ellipsis> Adding translations </span> </a> </li> <li class=md-nav__item> <a href=contributing/making-a-pull-request/ class=md-nav__link> <span class=md-ellipsis> Making a pull request </span> </a> </li> <li class=md-nav__item> <a href=https://github.com/squidfunk/mkdocs-material/discussions class=md-nav__link> <span class=md-ellipsis> Asking a question </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_7_2> <label class=md-nav__link for=__nav_7_2 id=__nav_7_2_label tabindex=0> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_7_2_label aria-expanded=false> <label class=md-nav__title for=__nav_7_2> <span class="md-nav__icon md-icon"></span> Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=guides/creating-a-reproduction/ class=md-nav__link> <span class=md-ellipsis> Creating a reproduction </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_7_3> <div class="md-nav__link md-nav__container"> <a href=insiders/community-experts-program/ class="md-nav__link "> <span class=md-ellipsis> Community experts program </span> </a> </div> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_7_3_label aria-expanded=false> <label class=md-nav__title for=__nav_7_3> <span class="md-nav__icon md-icon"></span> Community experts program </label> <ul class=md-nav__list data-md-scrollfix> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_8> <div class="md-nav__link md-nav__container"> <a href=blog/ class="md-nav__link "> <span class=md-ellipsis> Blog </span> </a> <label class="md-nav__link " for=__nav_8 id=__nav_8_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Blog </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_8_2> <label class=md-nav__link for=__nav_8_2 id=__nav_8_2_label tabindex=0> <span class=md-ellipsis> Archive </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_2_label aria-expanded=false> <label class=md-nav__title for=__nav_8_2> <span class="md-nav__icon md-icon"></span> Archive </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=blog/archive/2024/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> 2024 </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/archive/2023/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> 2023 </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/archive/2022/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> 2022 </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/archive/2021/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> 2021 </span> </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_8_3> <label class=md-nav__link for=__nav_8_3 id=__nav_8_3_label tabindex=0> <span class=md-ellipsis> Categories </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_3_label aria-expanded=false> <label class=md-nav__title for=__nav_8_3> <span class="md-nav__icon md-icon"></span> Categories </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=blog/category/blog/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Blog </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/category/build/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Build </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/category/general/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> General </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/category/performance/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Performance </span> </span> </a> </li> <li class=md-nav__item> <a href=blog/category/search/ class=md-nav__link> <span class=md-ellipsis> <span class=md-typeset> Search </span> </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"annotate": {"json": [".s2"]}, "base": ".", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.code.select", "content.footnote.tooltips", "content.tooltips", "navigation.footer", "navigation.indexes", "navigation.sections", "navigation.tabs", "navigation.top", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "assets/javascripts/workers/search.c7c1ca2c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src=assets/javascripts/bundle.5a789024.min.js></script> <script src=js/timeago.min.js></script> <script src=js/timeago_mkdocs_material.js></script> <script src=assets/javascripts/custom.5863614d.min.js></script> <script type=application/ld+json> { "@context": "https://schema.org", "@type": "WebSite", "url": "https://squidfunk.github.io/mkdocs-material/", "potentialAction": { "@type": "SearchAction", "target": { "@type": "EntryPoint", "urlTemplate": "https://squidfunk.github.io/mkdocs-material/?q={search_term_string}" }, "query-input": "required name=search_term_string" } } </script> </body> </html>