Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-04 20:08:05 +01:00
Code Issues Releases Wiki Activity
485fa76fbc
mkdocs-material/docs/setup/index.md
Martin Donath cd008fdf29
Restructured documentation (#5692)
2023-09-14 19:09:18 +02:00

3.8 KiB
Raw Blame History

Setup

Material for MkDocs offers a wide range of options for customizing your documentation. In this section, we will explain how you can create a meaningful structure for your site, change the look and feel, add a blog and comment system, and build a highly optimized site.

Site structure

Set up and customize the structure of your documentation by configuring the header and footer to your taste, choosing among many modes of navigation, setting up site search, and more.

  • :fontawesome-solid-earth-americas: Language – Choose out of the 60+ supported languages or add a new one
  • :material-page-layout-sidebar-left: Navigation – Create a clear, concise, and comprehensive navigation structure
  • :material-page-layout-header: Header – Customize the behavior of the header, add an announcement bar
  • :material-page-layout-footer: Footer – Add links to your social media profiles or websites in the footer
  • :material-tab-search: Search – Set up and configure search, running entirely in the user's browser
  • :material-tag-plus-outline: Tags – Categorize your pages with tags and group related pages

Appearance

Match your brand's colors, fonts, icons, logo, and more with a few lines of configuration – Material for MkDocs makes it easy to extend the basic configuration or alter the appearance.

  • :material-brush-variant: Colors Change colors with an existing color palette or customize with CSS
  • :material-format-font: Fonts – Choose among 1,000 Google Fonts or load self-hosted fonts
  • :material-google-downasaur: Logo & Icons – Change the logo, use any of the 8,000+ icons, or add new ones
  • :material-cards-variant: Social Cards – Automatically create social media previews when sharing links

Content

Create a blog, integrate a comment system, connect a git repository, and set up versioned documentation that matches your project's versioning methodology.

  • :material-book-open-outline: Blog – Set up a standalone blog or host it alongside your documentation
  • :material-comment-text-outline: Comment System – Add a third-party comment system on any page or footer
  • :octicons-versions-16: Versioning – Deploy multiple versions by integrating with external utilities
  • :octicons-repo-16: Repository – Connect your documentation to your git repository

Optimization

Add site analytics and build an optimized site by adding automatic image compression, complying with GDPR data privacy regulations, and making it offline-capable.

  • :material-google-analytics: Site analytics – Learn how your users experience your documentation
  • :material-screwdriver: Optimized site – Create optimized sites that rank great on search engines
  • :octicons-lock-16: Data Privacy – Ensure compliance with data privacy regulations
  • :octicons-cloud-offline-16: Offline usage – Build an online and offline-capable documentation