Skip to content

Commit 4586c0f

Browse files
katharinalisalinkatharinalisalin
committed
Added setup index.md
1 parent c4adfa9 commit 4586c0f

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed

‎docs/setup/index.md

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Setup
2+
3+
Material for MkDocs offers a wide range of options for customizing and adjusting
4+
your documentation. In this section, we will explain how to make the most use of
5+
Material for MkDocs to change the look of your documentation, add more content,
6+
improve its functionality, and work with extensions.
7+
8+
## Customizing the look
9+
10+
Make your documentation reflect your brand by changing its colors, fonts, icons,
11+
logo, and more with just a few lines of configuration. Material for MkDocs makes
12+
it easy to extend the basic configurations and provides many options to alter
13+
the appearance.
14+
15+
<div class="grid cards" markdown>
16+
17+
- :material-brush-variant: __[Colors]__ – Change colors with an existing color palette or customize with CSS
18+
- :fontawesome-regular-file-word: __[Fonts]__ – Change fonts using Google Fonts or load self-hosted fonts
19+
- :material-google-downasaur: __[Logo & Icons]__ – Change the logo, use any of the +8,000 icons, or add new ones
20+
21+
</div>
22+
23+
[Colors]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
24+
[Fonts]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
25+
[Logo & Icons]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/
26+
27+
## Adding additional content
28+
29+
Easily extend the content of your documentation. Adjusting headers, including a
30+
footer, creating a blog, implementing comment systems, and automatically creating
31+
social media previews.
32+
33+
<div class="grid cards" markdown>
34+
35+
- :material-format-header-1: __[Header]__ – Customize the header using different configurations
36+
- :material-format-font-size-decrease: __[Footer]__ – Add links to social media or other websites in the footer
37+
- :material-cards-variant: __[Social Cards]__ – Create automated Social Media previews when sharing links
38+
- :material-book-open-outline: __[Blog]__ – Build a standalone blog or expand your documentation with one
39+
- :material-comment-text-outline: __[Comment System]__ – Add a third-party comment system on any page or footer
40+
41+
</div>
42+
43+
[Header]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/
44+
[Footer]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/
45+
[Social Cards]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
46+
[Blog]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-a-blog/
47+
[Comment System]: https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/
48+
49+
## Enhancing functionality
50+
51+
Improve the functionality of your documentation by integrating navigation and
52+
site search, categorizing pages using tags, changing the language, or adding
53+
multiple languages, and deploying multiple versions.
54+
55+
<div class="grid cards" markdown>
56+
57+
- :material-navigation-variant-outline: __[Navigation]__ – Create a clear, concise, and comprehensive navigation structure
58+
- :material-tab-search: __[Site Search]__ – Set up an excellent client-side search implementation
59+
- :fontawesome-solid-earth-americas: __[Language]__ – Change the language using one of the +50 existing translations
60+
- :octicons-tag-16: __[Tags]__ – Categorize your pages with tags and group related pages
61+
- :octicons-versions-16: __[Versioning]__ – Deploy multiple versions by integrating with external utilities
62+
63+
</div>
64+
65+
[Navigation]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
66+
[Site Search]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
67+
[Language]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/
68+
[Tags]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
69+
[Versioning]: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
70+
71+
## Optimizing your site
72+
73+
Optimize your site by displaying information from your Git repository, getting a
74+
higher ranking on search engines, ensuring compliance with data privacy
75+
regulations, and unlocking offline usage.
76+
77+
<div class="grid cards" markdown>
78+
79+
- :fontawesome-brands-git: __[Git Repository]__ – Display information to your project's repository on your static site
80+
- :material-screwdriver: __[Optimized site]__ – Create optimized sites that rank great on search engines, i.a.
81+
- :octicons-lock-16: __[Data Privacy]__ – Ensure compliance with data privacy regulations
82+
- :octicons-cloud-offline-16: __[Offline usage]__ – Build an online and offline-capable documentation
83+
84+
</div>
85+
86+
[Git Repository]: https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/
87+
[Optimized site]: https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/
88+
[Data Privacy]: https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/
89+
[Offline usage]: https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/
90+
91+
## Working with extensions
92+
93+
Extend the range of available features and enhance your technical writing by
94+
working with extensions in your documentation.
95+
96+
<div class="grid cards" markdown>
97+
98+
- :material-language-python: __[Python Markdown]__ – Unlock a large range of features that require Python Markdown
99+
- :material-plus-box: __[Python Markdown Extension]__ – Advance your technical writing with a collection of extensions
100+
101+
</div>
102+
103+
[Python Markdown]: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/
104+
[Python Markdown Extension]: https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/
105+
106+
## Dependencies
107+
108+
Install external libraries to allow for image processing as part of the build
109+
pipeline to make use of social cards and image optimization features.
110+
111+
<div class="grid cards" markdown>
112+
113+
- :fontawesome-regular-image: __[Image processing]__ – Install external libraries for image processing during the build pipeline
114+
115+
</div>
116+
117+
[Image processing]: https://squidfunk.github.io/mkdocs-material/setup/dependencies/image-processing/

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,7 @@ nav:
179179
- Guides:
180180
- Creating a reproduction: guides/creating-a-reproduction.md
181181
- Setup:
182+
- setup/index.md
182183
- Changing the colors: setup/changing-the-colors.md
183184
- Changing the fonts: setup/changing-the-fonts.md
184185
- Changing the language: setup/changing-the-language.md

0 commit comments

Comments
 (0)