1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-12-13 16:21:14 +01:00
mkdocs-material/docs/setup/index.md

91 lines
3.8 KiB
Markdown
Raw Normal View History

2023-04-06 15:03:41 +02:00
# Setup
2023-04-07 18:07:56 +02:00
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
2023-04-10 13:12:27 +02:00
structure for your site, change the look and feel, add a blog and comment system,
2023-04-07 18:07:56 +02:00
and build a highly optimized site.
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
## Site structure
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
Set up and customize the structure of your documentation by configuring the
header and footer to your taste, choosing among many modes of navigation,
2023-04-10 13:12:27 +02:00
setting up site search, and more.
2023-04-06 15:03:41 +02:00
<div class="grid cards" markdown>
2023-05-02 11:30:22 +02:00
- :fontawesome-solid-earth-americas: __[Language]__ Choose out of the 60+ supported languages or add a new one
2023-04-07 18:07:56 +02:00
- :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
2023-09-14 19:09:18 +02:00
- :material-page-layout-footer: __[Footer]__ Add links to your social media profiles or websites in the footer
2023-04-07 18:07:56 +02:00
- :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
2023-04-06 15:03:41 +02:00
</div>
2023-04-07 18:07:56 +02:00
[Language]: changing-the-language.md
[Navigation]: setting-up-navigation.md
[Header]: setting-up-the-header.md
[Footer]: setting-up-the-footer.md
[Search]: setting-up-site-search.md
[Tags]: setting-up-tags.md
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
## 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.
2023-04-06 15:03:41 +02:00
<div class="grid cards" markdown>
2023-04-07 18:07:56 +02:00
- :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
2023-04-06 15:03:41 +02:00
</div>
2023-04-07 18:07:56 +02:00
[Colors]: changing-the-colors.md
[Fonts]: changing-the-fonts.md
[Logo & Icons]: changing-the-logo-and-icons.md
[Social Cards]: setting-up-social-cards.md
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
## Content
2023-04-06 15:03:41 +02:00
2023-04-10 13:12:27 +02:00
Create a blog, integrate a comment system, connect a git repository, and set up
versioned documentation that matches your project's versioning methodology.
2023-04-06 15:03:41 +02:00
<div class="grid cards" markdown>
2023-04-07 18:07:56 +02:00
- :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
2023-04-06 15:03:41 +02:00
- :octicons-versions-16: __[Versioning]__ Deploy multiple versions by integrating with external utilities
2023-04-07 18:07:56 +02:00
- :octicons-repo-16: __[Repository]__ Connect your documentation to your git repository
2023-04-06 15:03:41 +02:00
</div>
2023-04-07 18:07:56 +02:00
[Blog]: setting-up-a-blog.md
[Comment System]: adding-a-comment-system.md
2023-09-14 19:09:18 +02:00
[Versioning]: setting-up-versioning.md
2023-04-07 18:07:56 +02:00
[Repository]: adding-a-git-repository.md
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
## Optimization
2023-04-06 15:03:41 +02:00
2023-04-07 18:07:56 +02:00
Add site analytics and build an optimized site by adding automatic image
2023-04-10 13:12:27 +02:00
compression, complying with GDPR data privacy regulations, and making it
2023-04-07 18:07:56 +02:00
offline-capable.
2023-04-06 15:03:41 +02:00
<div class="grid cards" markdown>
2023-04-07 18:07:56 +02:00
- :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
2023-04-06 15:03:41 +02:00
- :octicons-lock-16: __[Data Privacy]__ Ensure compliance with data privacy regulations
- :octicons-cloud-offline-16: __[Offline usage]__ Build an online and offline-capable documentation
</div>
2023-04-10 14:06:05 +02:00
[Site analytics]: setting-up-site-analytics.md
2023-04-07 18:07:56 +02:00
[Optimized site]: building-an-optimized-site.md
[Data Privacy]: ensuring-data-privacy.md
[Offline usage]: building-for-offline-usage.md