1
0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-28 01:10:58 +01:00

Documentation

This commit is contained in:
squidfunk 2022-11-01 12:41:27 +07:00
parent 4caa165b97
commit 080fccd65a
51 changed files with 21 additions and 137 deletions

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Alternatives
There are tons of static site generators and themes out there and choosing the

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Browser support
Material for MkDocs goes at great lengths to support the largest possible range

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Changelog
## Material for MkDocs

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Creating your site
After you've [installed] Material for MkDocs, you can bootstrap your project

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Customization
Project documentation is as diverse as the projects themselves and Material for

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Getting started
Material for MkDocs is a theme for [MkDocs], a static site generator geared

View File

@ -1,4 +1,6 @@
---
template: overrides/home.html
template: home.html
title: Material for MkDocs
---
Welcome to Material for MkDocs.

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Changelog
## Material for MkDocs Insiders

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Getting started with Insiders
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Insiders
---

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# License
**MIT License**

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Philosophy
Before settling for Material for MkDocs, it's a good idea to understand the

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Publishing your site
The great thing about hosting project documentation in a `git` repository is

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/alert-outline
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/plus-circle
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/gesture-tap-button
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/code-json
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/tab
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/table-edit
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/graph-outline
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-align-bottom
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-font
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/view-grid-plus
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/emoticon-happy-outline
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/image-frame
---

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Reference
Material for MkDocs is packed with many great features that make technical

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/format-list-bulleted
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/alphabet-greek
---

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
icon: material/tooltip-plus
status: new
---

View File

@ -9872,6 +9872,7 @@
"simple/azurefunctions",
"simple/azurepipelines",
"simple/babel",
"simple/backblaze",
"simple/backbonedotjs",
"simple/backendless",
"simple/badgr",
@ -9905,6 +9906,8 @@
"simple/bigcartel",
"simple/bigcommerce",
"simple/bilibili",
"simple/billboard",
"simple/bim",
"simple/binance",
"simple/biolink",
"simple/bit",
@ -10112,6 +10115,7 @@
"simple/cplusplus",
"simple/craftcms",
"simple/cratedb",
"simple/crayon",
"simple/createreactapp",
"simple/creativecommons",
"simple/credly",
@ -10215,6 +10219,7 @@
"simple/dotnet",
"simple/douban",
"simple/doubanread",
"simple/dovecot",
"simple/dpd",
"simple/dragonframe",
"simple/draugiemdotlv",
@ -10275,6 +10280,7 @@
"simple/emirates",
"simple/emlakjet",
"simple/empirekred",
"simple/engadget",
"simple/enpass",
"simple/enterprisedb",
"simple/envato",
@ -10347,6 +10353,7 @@
"simple/firebase",
"simple/firefox",
"simple/firefoxbrowser",
"simple/fireship",
"simple/first",
"simple/fitbit",
"simple/fite",
@ -10382,6 +10389,7 @@
"simple/fossilscm",
"simple/foursquare",
"simple/foursquarecityguide",
"simple/fox",
"simple/foxtel",
"simple/fozzy",
"simple/framer",
@ -10516,6 +10524,7 @@
"simple/groupon",
"simple/grubhub",
"simple/grunt",
"simple/gsk",
"simple/gtk",
"simple/guangzhoumetro",
"simple/guilded",
@ -10550,6 +10559,7 @@
"simple/hcl",
"simple/headlessui",
"simple/headspace",
"simple/hedera",
"simple/hellofresh",
"simple/hellyhansen",
"simple/helm",
@ -10637,6 +10647,7 @@
"simple/instapaper",
"simple/instatus",
"simple/instructables",
"simple/instructure",
"simple/integromat",
"simple/intel",
"simple/intellijidea",
@ -10963,6 +10974,7 @@
"simple/monster",
"simple/monzo",
"simple/moo",
"simple/moonrepo",
"simple/morrisons",
"simple/moscowmetro",
"simple/motorola",
@ -11151,10 +11163,12 @@
"simple/pelican",
"simple/peloton",
"simple/penny",
"simple/penpot",
"simple/pepsi",
"simple/percy",
"simple/perforce",
"simple/perl",
"simple/persistent",
"simple/personio",
"simple/petsathome",
"simple/peugeot",
@ -11285,6 +11299,7 @@
"simple/pypi",
"simple/pypy",
"simple/pyscaffold",
"simple/pysyft",
"simple/pytest",
"simple/python",
"simple/pytorch",
@ -11403,6 +11418,7 @@
"simple/rotaryinternational",
"simple/rottentomatoes",
"simple/roundcube",
"simple/rsocket",
"simple/rss",
"simple/rstudio",
"simple/rte",
@ -11652,6 +11668,7 @@
"simple/symphony",
"simple/sympy",
"simple/synology",
"simple/system76",
"simple/tableau",
"simple/tablecheck",
"simple/tacobell",
@ -11945,6 +11962,7 @@
"simple/workplace",
"simple/worldhealthorganization",
"simple/wpengine",
"simple/wpexplorer",
"simple/wprocket",
"simple/writedotas",
"simple/wwe",

View File

@ -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

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Adding a git repository
If your documentation is related to source code, Material for MkDocs provides

View File

@ -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

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Changing the colors
As any proper Material Design implementation, Material for MkDocs supports

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Changing the fonts
Material for MkDocs makes it easy to change the typeface of your project

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Changing the language
Material for MkDocs supports internationalization (i18n) and provides

View File

@ -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

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Ensuring data privacy
Material for MkDocs makes compliance with data privacy regulations very easy,

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
title: Extensions
---

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Python Markdown Extensions
The [Python Markdown Extensions] package is an excellent collection of

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Python Markdown
Material for MkDocs supports a large number of [Python Markdown] extensions,

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
status: new
---

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Setting up navigation
A clear and concise navigation structure is an important aspect of good project

View File

@ -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

View File

@ -1,5 +1,4 @@
---
template: overrides/main.html
search:
boost: 1.05
---

View File

@ -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

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Setting up tags
Material for MkDocs adds first-class support for categorizing pages with tags,

View File

@ -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

View File

@ -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

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# Setting up versioning
Material for MkDocs makes it easy to deploy multiple versions of your project

View File

@ -1,7 +1,3 @@
---
template: overrides/main.html
---
# How to upgrade
Upgrade to the latest version with: