Merge pull request #5357 from squidfunk/docs/setup

Updated setup page
This commit is contained in:
Kathi 2023-04-10 14:06:48 +02:00 committed by GitHub
commit 998265c3d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -2,14 +2,14 @@
Material for MkDocs offers a wide range of options for customizing your 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 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 structure for your site, change the look and feel, add a blog and comment system,
and build a highly optimized site. and build a highly optimized site.
## Site structure ## Site structure
Set up and customize the structure of your documentation by configuring the Set up and customize the structure of your documentation by configuring the
header and footer to your taste, choosing among many modes of navigation, header and footer to your taste, choosing among many modes of navigation,
setting up site search and more. setting up site search, and more.
<div class="grid cards" markdown> <div class="grid cards" markdown>
@ -52,8 +52,8 @@ configuration or alter the appearance.
## Content ## Content
Create a blog, integrate a comment system, connect a git repository and set up Create a blog, integrate a comment system, connect a git repository, and set up
versioned documentation that matches your project's versioning metholodogy. versioned documentation that matches your project's versioning methodology.
<div class="grid cards" markdown> <div class="grid cards" markdown>
@ -72,7 +72,7 @@ versioned documentation that matches your project's versioning metholodogy.
## Optimization ## Optimization
Add site analytics and build an optimized site by adding automatic image Add site analytics and build an optimized site by adding automatic image
compression, complying with GDPR data privacy regulations and make it compression, complying with GDPR data privacy regulations, and making it
offline-capable. offline-capable.
<div class="grid cards" markdown> <div class="grid cards" markdown>
@ -84,7 +84,7 @@ offline-capable.
</div> </div>
[Site analytics]: site-analytics.md [Site analytics]: setting-up-site-analytics.md
[Optimized site]: building-an-optimized-site.md [Optimized site]: building-an-optimized-site.md
[Data Privacy]: ensuring-data-privacy.md [Data Privacy]: ensuring-data-privacy.md
[Offline usage]: building-for-offline-usage.md [Offline usage]: building-for-offline-usage.md