[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"doc-seo-657581-105":3,"doc-detail-657581-en":80,"detail-sidebar-cat-0-en-105":98},{"code":4,"msg":5,"data":6},0,"ok",{"site_id":7,"language":8,"slug":9,"title":10,"keywords":11,"description":12,"schema_data":13,"social_meta":73,"head_meta":75,"extra_data":77,"updated_unix":79},105,"en","material-for-mkdocs-getting-started","Material for MkDocs - Getting Started","","Material for MkDocs provides a theme for MkDocs, a static site generator for (technical) project documentation. The guide explains installation using pip or Docker, including dependency handling and version usage, and shows how to set up a new documentation project with mkdocs new. It then covers theme configuration through mkdocs.yml, with minimal and advanced options, and describes previewing documentation via the live server command mkdocs serve for local updates.",{"@graph":14,"@context":72},[15,34,55],{"@type":16,"itemListElement":17},"BreadcrumbList",[18,23,27,31],{"item":19,"name":20,"@type":21,"position":22},"https://docshare.wps.com","Home","ListItem",1,{"item":24,"name":25,"@type":21,"position":26},"https://docshare.wps.com/document/","Document",2,{"item":28,"name":29,"@type":21,"position":30},"https://docshare.wps.com/document/technology/","Technology",3,{"item":32,"name":10,"@type":21,"position":33},"https://docshare.wps.com/document/material-for-mkdocs-getting-started/657581/",4,{"url":32,"name":10,"@type":35,"image":36,"author":41,"headline":10,"publisher":44,"fileFormat":47,"inLanguage":8,"description":12,"dateModified":48,"datePublished":49,"encodingFormat":47,"isAccessibleForFree":50,"interactionStatistic":51},"DigitalDocument",{"url":37,"@type":38,"width":39,"height":40},"https://docshare.wps.com/thumbnails/material-for-mkdocs-getting-started/657581.png","ImageObject",300,407,{"name":42,"@type":43},"Well Done","Person",{"url":19,"name":45,"@type":46},"DocShare","Organization","application/pdf","2026-10-27","2026-10-26",true,{"@type":52,"interactionType":53,"userInteractionCount":22},"InteractionCounter",{"@type":54},"ViewAction",{"@type":56,"mainEntity":57},"FAQPage",[58,64,68],{"name":59,"@type":60,"acceptedAnswer":61},"How can Material for MkDocs be installed using pip?","Question",{"text":62,"@type":63},"Install it with pip install mkdocs-material. This automatically brings compatible dependencies such as MkDocs and required Markdown extensions.","Answer",{"name":65,"@type":60,"acceptedAnswer":66},"How do you run Material for MkDocs from Docker?",{"text":67,"@type":63},"Use the official Docker image and start the container with docker run, then access the site through the mapped localhost port. The image includes dependencies pre-installed.",{"name":69,"@type":60,"acceptedAnswer":70},"What basic steps are needed to create and configure a new documentation site?",{"text":71,"@type":63},"Create the site with mkdocs new . and enable the theme by adding theme: name: material to mkdocs.yml. You can then apply further configuration options such as fonts, icons, and search settings.","https://schema.org",{"og:url":32,"og:type":74,"og:title":10,"og:site_name":45,"og:description":12},"article",{"robots":76,"canonical":32},"index,follow",{"doc_id":78,"site_id":7},657581,1793073591,{"code":4,"msg":81,"data":82},"success",{"doc_id":78,"user_id":83,"nickname":42,"user_avatar":84,"doc_module":4,"category_id":85,"category_name":29,"doc_title":10,"doc_description":12,"doc_content":86,"file_id":87,"file_url":88,"file_type":89,"file_size":90,"view_count":22,"is_deleted":4,"is_public":22,"is_downloadable":22,"audit_status":22,"page_count":91,"language":92,"language_code":8,"site_id":7,"html_lang":8,"table_of_contents":93,"faqs":94,"seo_title":95,"seo_description":12,"update_tm":96,"read_time":97},5909892210082,"https://ap-avatar.wpscdn.com/avatar/56001069da27c9f41e8?x-image-process=image/resize,m_fixed,w_180,h_180&k=1789614185077863061",6,"Material for MkDocs  \nTechnical documentation that just works  \nMartin Donath  \nCopyright © 2016-2021 Martin Donath  \nTable of contents  \n1. Getting started 4  \n1.1 Getting started 4  \n1.2 Creating your site 5  \n1.3 Publishing your site 7  \n1.4 Customization 8  \n1.5 Troubleshooting 10  \n1.6 Data privacy 11  \n1.7 License 12  \n1.8 Releases 13  \n2. Setup 33  \n2.1 Changing the colors 33  \n2.2 Changing the fonts 35  \n2.3 Changing the language 36  \n2.4 Changing the logo and icons 38  \n2.5 Setting up navigation 39  \n2.6 Setting up site search 45  \n2.7 Setting up site analytics 48  \n2.8 Setting up versioning 49  \n2.9 Setting up the header 51  \n2.10 Setting up the footer 52  \n2.11 Adding a git repository 53  \n2.12 Adding a comment system 55  \n3. Reference 56  \n3.1 Abbreviations 56  \n3.2 Admonitions 57  \n3.3 Buttons 61  \n3.4 Code blocks 62  \n3.5 Content tabs 65  \n3.6 Data tables 67  \n3.7 Diagrams 69  \n3.8 Footnotes 70  \n3.9 Formatting 71  \n3.10 Icons + Emojis 73  \n3.11 Images 75  \n3.12 Lists 76  \n- 2/87 - Copyright © 2016 - 2021 Martin Donath  \n3.13 MathJax 78  \n3.14 Meta tags 79  \n3.15 Variables 80  \n4. Insiders 81  \n4.1 Insiders 81  \n4.2 Getting started 84  \n- 3/87 - Copyright © 2016 - 2021 Martin Donath  \n1. Getting started  \n1.1 Getting started  \nMaterial for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation. If you're familiar with Python, you can install Material for MkDocs with  pip , the Python package manager. If not, we recommended using  docker .  \nIn case you're running into problems, consult the troubleshooting section.  \n1.1.1 Installation  \nwith pip  \nMaterial for MkDocs can be installed with  pip :  \npip install mkdocs-material  \nThis will automatically install compatible versions of all dependencies: MkDocs, Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.  \nwith docker  \nThe official Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed. Pull the image for the  latest  version with:  \ndocker pull squidfunk/mkdocs-material  \nThe  mkdocs  executable is provided as an entry point and  serve  is the default command. If you're not familiar with Docker don't worry, we have you covered in the following sections.  \nThe following plugins are bundled with the Docker image:  \nHow to add plugins to the Docker image?  \nMaterial for MkDocs bundles useful and common plugins while trying not to blow up the size of the official image. If the plugin you want to use is not included, create a new  Dockerfile  and extend the official Docker image with your custom installation routine:  \nFROM squidfunk/mkdocs-material RUN pip install ..  \nNext, you can build the image with the following command:  \ndocker build -t squidfunk/mkdocs-material .  \nThe new image can be used exactly like the official image.  \nwith git  \nMaterial for MkDocs can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:  \ng it clone [https://g ithub.com/squidfunk/mkdocs-material.g it](https://g ithub.com/squidfunk/mkdocs-material.g it)  \nThe theme will reside in the folder  mkdocs-material/material . When cloning from g it , you must install all required dependencies yourself:  \n• mkdocs-minify-plugin  \n• mkdocs-redirects  \npip install -r mkdocs-material/requirements .txt  \n- 4/87 - Copyright © 2016 - 2021 Martin Donath  \n1.2 Creating your site  \nAfter you've installed Material for MkDocs, you can bootstrap your project documentation using the  mkdocs  executable. Go to the directory where you want your project to be located and enter:  \nmkdocs new .  \nAlternatively, if you're running Material for MkDocs from within Docker, use:  \nUnix  \ndocker run --rm -it -v ${PWD}:/docs squidfunk/mkdocs-material new .  \nWindows  \ndocker run --rm -it","cbCaiqa0j9ll0R7c","https://ap.wps.com/l/cbCaiqa0j9ll0R7c","pdf",8801668,87,"English","# Getting started\n## Getting started\n## Creating your site\n## Previewing as you write\n# Setup\n## Changing the colors\n## Changing the fonts\n## Changing the language\n## Troubleshooting\n# Reference\n## Abbreviations\n## Admonitions\n## Buttons","[{\"question\":\"How can Material for MkDocs be installed using pip?\",\"answer\":\"Install it with pip install mkdocs-material. This automatically brings compatible dependencies such as MkDocs and required Markdown extensions.\"},{\"question\":\"How do you run Material for MkDocs from Docker?\",\"answer\":\"Use the official Docker image and start the container with docker run, then access the site through the mapped localhost port. The image includes dependencies pre-installed.\"},{\"question\":\"What basic steps are needed to create and configure a new documentation site?\",\"answer\":\"Create the site with mkdocs new . and enable the theme by adding theme: name: material to mkdocs.yml. You can then apply further configuration options such as fonts, icons, and search settings.\"}]","Material for MkDocs - Getting Started | PDF",1792983754,219,{"code":4,"msg":81,"data":99},[100,104,108,112,117,120,125,130,135,138,142],{"id":22,"doc_module":4,"doc_module_name":25,"category_name":101,"show_sort_weight":102,"slug":103},"Story & Novel",90,"story-novel",{"id":26,"doc_module":4,"doc_module_name":25,"category_name":105,"show_sort_weight":106,"slug":107},"Literature",80,"literature",{"id":33,"doc_module":4,"doc_module_name":25,"category_name":109,"show_sort_weight":110,"slug":111},"Exam",70,"exam",{"id":113,"doc_module":4,"doc_module_name":25,"category_name":114,"show_sort_weight":115,"slug":116},5,"Comic",60,"comic",{"id":85,"doc_module":4,"doc_module_name":25,"category_name":29,"show_sort_weight":118,"slug":119},50,"technology",{"id":121,"doc_module":4,"doc_module_name":25,"category_name":122,"show_sort_weight":123,"slug":124},7,"Healthcare",40,"healthcare",{"id":126,"doc_module":4,"doc_module_name":25,"category_name":127,"show_sort_weight":128,"slug":129},8,"Research & Report",30,"research-report",{"id":131,"doc_module":4,"doc_module_name":25,"category_name":132,"show_sort_weight":133,"slug":134},9,"Religion & Spirituality",20,"religion-spirituality",{"id":133,"doc_module":4,"doc_module_name":25,"category_name":136,"show_sort_weight":133,"slug":137},"World Cup","world-cup",{"id":139,"doc_module":4,"doc_module_name":25,"category_name":140,"show_sort_weight":139,"slug":141},10,"Lifestyle","lifestyle",{"id":143,"doc_module":4,"doc_module_name":25,"category_name":144,"show_sort_weight":113,"slug":145},19,"General","general"]