mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-07-22 05:53:03 -04:00
Documentation
This commit is contained in:
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Adding a comment system
|
||||
|
||||
Material for MkDocs allows to easily add the third-party comment system of your
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Adding a git repository
|
||||
|
||||
If your documentation is related to source code, Material for MkDocs provides
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Building for offline usage
|
||||
|
||||
If you want to ship your documentation together with your product, MkDocs has
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Changing the colors
|
||||
|
||||
As any proper Material Design implementation, Material for MkDocs supports
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Changing the fonts
|
||||
|
||||
Material for MkDocs makes it easy to change the typeface of your project
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Changing the language
|
||||
|
||||
Material for MkDocs supports internationalization (i18n) and provides
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Changing the logo and icons
|
||||
|
||||
When installing Material for MkDocs, you immediately get access to _over 8,000
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Ensuring data privacy
|
||||
|
||||
Material for MkDocs makes compliance with data privacy regulations very easy,
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
title: Extensions
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Python Markdown Extensions
|
||||
|
||||
The [Python Markdown Extensions] package is an excellent collection of
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Python Markdown
|
||||
|
||||
Material for MkDocs supports a large number of [Python Markdown] extensions,
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
status: new
|
||||
---
|
||||
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up navigation
|
||||
|
||||
A clear and concise navigation structure is an important aspect of good project
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up site analytics
|
||||
|
||||
As with any other service offered on the web, understanding how your project
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
search:
|
||||
boost: 1.05
|
||||
---
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up social cards
|
||||
|
||||
Social cards, also known as social previews, are images that are displayed when
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up tags
|
||||
|
||||
Material for MkDocs adds first-class support for categorizing pages with tags,
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up the footer
|
||||
|
||||
The footer of your project documentation is a great place to add links to
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up the header
|
||||
|
||||
Material for MkDocs' header can be customized to show an announcement bar that
|
||||
|
||||
@@ -1,7 +1,3 @@
|
||||
---
|
||||
template: overrides/main.html
|
||||
---
|
||||
|
||||
# Setting up versioning
|
||||
|
||||
Material for MkDocs makes it easy to deploy multiple versions of your project
|
||||
|
||||
Reference in New Issue
Block a user