mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Documentation
This commit is contained in:
parent
4caa165b97
commit
080fccd65a
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Alternatives
|
# Alternatives
|
||||||
|
|
||||||
There are tons of static site generators and themes out there and choosing the
|
There are tons of static site generators and themes out there and choosing the
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Browser support
|
# Browser support
|
||||||
|
|
||||||
Material for MkDocs goes at great lengths to support the largest possible range
|
Material for MkDocs goes at great lengths to support the largest possible range
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## Material for MkDocs
|
## Material for MkDocs
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Creating your site
|
# Creating your site
|
||||||
|
|
||||||
After you've [installed] Material for MkDocs, you can bootstrap your project
|
After you've [installed] Material for MkDocs, you can bootstrap your project
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Customization
|
# Customization
|
||||||
|
|
||||||
Project documentation is as diverse as the projects themselves and Material for
|
Project documentation is as diverse as the projects themselves and Material for
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
|
|
||||||
Material for MkDocs is a theme for [MkDocs], a static site generator geared
|
Material for MkDocs is a theme for [MkDocs], a static site generator geared
|
||||||
|
@ -1,4 +1,6 @@
|
|||||||
---
|
---
|
||||||
template: overrides/home.html
|
template: home.html
|
||||||
title: Material for MkDocs
|
title: Material for MkDocs
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Welcome to Material for MkDocs.
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## Material for MkDocs Insiders
|
## Material for MkDocs Insiders
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
title: Getting started with Insiders
|
title: Getting started with Insiders
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
title: Insiders
|
title: Insiders
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
**MIT License**
|
**MIT License**
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Philosophy
|
# Philosophy
|
||||||
|
|
||||||
Before settling for Material for MkDocs, it's a good idea to understand the
|
Before settling for Material for MkDocs, it's a good idea to understand the
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Publishing your site
|
# Publishing your site
|
||||||
|
|
||||||
The great thing about hosting project documentation in a `git` repository is
|
The great thing about hosting project documentation in a `git` repository is
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/alert-outline
|
icon: material/alert-outline
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/plus-circle
|
icon: material/plus-circle
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/gesture-tap-button
|
icon: material/gesture-tap-button
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/code-json
|
icon: material/code-json
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/tab
|
icon: material/tab
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/table-edit
|
icon: material/table-edit
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/graph-outline
|
icon: material/graph-outline
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/format-align-bottom
|
icon: material/format-align-bottom
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/format-font
|
icon: material/format-font
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/view-grid-plus
|
icon: material/view-grid-plus
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/emoticon-happy-outline
|
icon: material/emoticon-happy-outline
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/image-frame
|
icon: material/image-frame
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Reference
|
# Reference
|
||||||
|
|
||||||
Material for MkDocs is packed with many great features that make technical
|
Material for MkDocs is packed with many great features that make technical
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/format-list-bulleted
|
icon: material/format-list-bulleted
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/alphabet-greek
|
icon: material/alphabet-greek
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
icon: material/tooltip-plus
|
icon: material/tooltip-plus
|
||||||
status: new
|
status: new
|
||||||
---
|
---
|
||||||
|
@ -9872,6 +9872,7 @@
|
|||||||
"simple/azurefunctions",
|
"simple/azurefunctions",
|
||||||
"simple/azurepipelines",
|
"simple/azurepipelines",
|
||||||
"simple/babel",
|
"simple/babel",
|
||||||
|
"simple/backblaze",
|
||||||
"simple/backbonedotjs",
|
"simple/backbonedotjs",
|
||||||
"simple/backendless",
|
"simple/backendless",
|
||||||
"simple/badgr",
|
"simple/badgr",
|
||||||
@ -9905,6 +9906,8 @@
|
|||||||
"simple/bigcartel",
|
"simple/bigcartel",
|
||||||
"simple/bigcommerce",
|
"simple/bigcommerce",
|
||||||
"simple/bilibili",
|
"simple/bilibili",
|
||||||
|
"simple/billboard",
|
||||||
|
"simple/bim",
|
||||||
"simple/binance",
|
"simple/binance",
|
||||||
"simple/biolink",
|
"simple/biolink",
|
||||||
"simple/bit",
|
"simple/bit",
|
||||||
@ -10112,6 +10115,7 @@
|
|||||||
"simple/cplusplus",
|
"simple/cplusplus",
|
||||||
"simple/craftcms",
|
"simple/craftcms",
|
||||||
"simple/cratedb",
|
"simple/cratedb",
|
||||||
|
"simple/crayon",
|
||||||
"simple/createreactapp",
|
"simple/createreactapp",
|
||||||
"simple/creativecommons",
|
"simple/creativecommons",
|
||||||
"simple/credly",
|
"simple/credly",
|
||||||
@ -10215,6 +10219,7 @@
|
|||||||
"simple/dotnet",
|
"simple/dotnet",
|
||||||
"simple/douban",
|
"simple/douban",
|
||||||
"simple/doubanread",
|
"simple/doubanread",
|
||||||
|
"simple/dovecot",
|
||||||
"simple/dpd",
|
"simple/dpd",
|
||||||
"simple/dragonframe",
|
"simple/dragonframe",
|
||||||
"simple/draugiemdotlv",
|
"simple/draugiemdotlv",
|
||||||
@ -10275,6 +10280,7 @@
|
|||||||
"simple/emirates",
|
"simple/emirates",
|
||||||
"simple/emlakjet",
|
"simple/emlakjet",
|
||||||
"simple/empirekred",
|
"simple/empirekred",
|
||||||
|
"simple/engadget",
|
||||||
"simple/enpass",
|
"simple/enpass",
|
||||||
"simple/enterprisedb",
|
"simple/enterprisedb",
|
||||||
"simple/envato",
|
"simple/envato",
|
||||||
@ -10347,6 +10353,7 @@
|
|||||||
"simple/firebase",
|
"simple/firebase",
|
||||||
"simple/firefox",
|
"simple/firefox",
|
||||||
"simple/firefoxbrowser",
|
"simple/firefoxbrowser",
|
||||||
|
"simple/fireship",
|
||||||
"simple/first",
|
"simple/first",
|
||||||
"simple/fitbit",
|
"simple/fitbit",
|
||||||
"simple/fite",
|
"simple/fite",
|
||||||
@ -10382,6 +10389,7 @@
|
|||||||
"simple/fossilscm",
|
"simple/fossilscm",
|
||||||
"simple/foursquare",
|
"simple/foursquare",
|
||||||
"simple/foursquarecityguide",
|
"simple/foursquarecityguide",
|
||||||
|
"simple/fox",
|
||||||
"simple/foxtel",
|
"simple/foxtel",
|
||||||
"simple/fozzy",
|
"simple/fozzy",
|
||||||
"simple/framer",
|
"simple/framer",
|
||||||
@ -10516,6 +10524,7 @@
|
|||||||
"simple/groupon",
|
"simple/groupon",
|
||||||
"simple/grubhub",
|
"simple/grubhub",
|
||||||
"simple/grunt",
|
"simple/grunt",
|
||||||
|
"simple/gsk",
|
||||||
"simple/gtk",
|
"simple/gtk",
|
||||||
"simple/guangzhoumetro",
|
"simple/guangzhoumetro",
|
||||||
"simple/guilded",
|
"simple/guilded",
|
||||||
@ -10550,6 +10559,7 @@
|
|||||||
"simple/hcl",
|
"simple/hcl",
|
||||||
"simple/headlessui",
|
"simple/headlessui",
|
||||||
"simple/headspace",
|
"simple/headspace",
|
||||||
|
"simple/hedera",
|
||||||
"simple/hellofresh",
|
"simple/hellofresh",
|
||||||
"simple/hellyhansen",
|
"simple/hellyhansen",
|
||||||
"simple/helm",
|
"simple/helm",
|
||||||
@ -10637,6 +10647,7 @@
|
|||||||
"simple/instapaper",
|
"simple/instapaper",
|
||||||
"simple/instatus",
|
"simple/instatus",
|
||||||
"simple/instructables",
|
"simple/instructables",
|
||||||
|
"simple/instructure",
|
||||||
"simple/integromat",
|
"simple/integromat",
|
||||||
"simple/intel",
|
"simple/intel",
|
||||||
"simple/intellijidea",
|
"simple/intellijidea",
|
||||||
@ -10963,6 +10974,7 @@
|
|||||||
"simple/monster",
|
"simple/monster",
|
||||||
"simple/monzo",
|
"simple/monzo",
|
||||||
"simple/moo",
|
"simple/moo",
|
||||||
|
"simple/moonrepo",
|
||||||
"simple/morrisons",
|
"simple/morrisons",
|
||||||
"simple/moscowmetro",
|
"simple/moscowmetro",
|
||||||
"simple/motorola",
|
"simple/motorola",
|
||||||
@ -11151,10 +11163,12 @@
|
|||||||
"simple/pelican",
|
"simple/pelican",
|
||||||
"simple/peloton",
|
"simple/peloton",
|
||||||
"simple/penny",
|
"simple/penny",
|
||||||
|
"simple/penpot",
|
||||||
"simple/pepsi",
|
"simple/pepsi",
|
||||||
"simple/percy",
|
"simple/percy",
|
||||||
"simple/perforce",
|
"simple/perforce",
|
||||||
"simple/perl",
|
"simple/perl",
|
||||||
|
"simple/persistent",
|
||||||
"simple/personio",
|
"simple/personio",
|
||||||
"simple/petsathome",
|
"simple/petsathome",
|
||||||
"simple/peugeot",
|
"simple/peugeot",
|
||||||
@ -11285,6 +11299,7 @@
|
|||||||
"simple/pypi",
|
"simple/pypi",
|
||||||
"simple/pypy",
|
"simple/pypy",
|
||||||
"simple/pyscaffold",
|
"simple/pyscaffold",
|
||||||
|
"simple/pysyft",
|
||||||
"simple/pytest",
|
"simple/pytest",
|
||||||
"simple/python",
|
"simple/python",
|
||||||
"simple/pytorch",
|
"simple/pytorch",
|
||||||
@ -11403,6 +11418,7 @@
|
|||||||
"simple/rotaryinternational",
|
"simple/rotaryinternational",
|
||||||
"simple/rottentomatoes",
|
"simple/rottentomatoes",
|
||||||
"simple/roundcube",
|
"simple/roundcube",
|
||||||
|
"simple/rsocket",
|
||||||
"simple/rss",
|
"simple/rss",
|
||||||
"simple/rstudio",
|
"simple/rstudio",
|
||||||
"simple/rte",
|
"simple/rte",
|
||||||
@ -11652,6 +11668,7 @@
|
|||||||
"simple/symphony",
|
"simple/symphony",
|
||||||
"simple/sympy",
|
"simple/sympy",
|
||||||
"simple/synology",
|
"simple/synology",
|
||||||
|
"simple/system76",
|
||||||
"simple/tableau",
|
"simple/tableau",
|
||||||
"simple/tablecheck",
|
"simple/tablecheck",
|
||||||
"simple/tacobell",
|
"simple/tacobell",
|
||||||
@ -11945,6 +11962,7 @@
|
|||||||
"simple/workplace",
|
"simple/workplace",
|
||||||
"simple/worldhealthorganization",
|
"simple/worldhealthorganization",
|
||||||
"simple/wpengine",
|
"simple/wpengine",
|
||||||
|
"simple/wpexplorer",
|
||||||
"simple/wprocket",
|
"simple/wprocket",
|
||||||
"simple/writedotas",
|
"simple/writedotas",
|
||||||
"simple/wwe",
|
"simple/wwe",
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Adding a comment system
|
# Adding a comment system
|
||||||
|
|
||||||
Material for MkDocs allows to easily add the third-party comment system of your
|
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
|
# Adding a git repository
|
||||||
|
|
||||||
If your documentation is related to source code, Material for MkDocs provides
|
If your documentation is related to source code, Material for MkDocs provides
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Building for offline usage
|
# Building for offline usage
|
||||||
|
|
||||||
If you want to ship your documentation together with your product, MkDocs has
|
If you want to ship your documentation together with your product, MkDocs has
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changing the colors
|
# Changing the colors
|
||||||
|
|
||||||
As any proper Material Design implementation, Material for MkDocs supports
|
As any proper Material Design implementation, Material for MkDocs supports
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changing the fonts
|
# Changing the fonts
|
||||||
|
|
||||||
Material for MkDocs makes it easy to change the typeface of your project
|
Material for MkDocs makes it easy to change the typeface of your project
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changing the language
|
# Changing the language
|
||||||
|
|
||||||
Material for MkDocs supports internationalization (i18n) and provides
|
Material for MkDocs supports internationalization (i18n) and provides
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Changing the logo and icons
|
# Changing the logo and icons
|
||||||
|
|
||||||
When installing Material for MkDocs, you immediately get access to _over 8,000
|
When installing Material for MkDocs, you immediately get access to _over 8,000
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Ensuring data privacy
|
# Ensuring data privacy
|
||||||
|
|
||||||
Material for MkDocs makes compliance with data privacy regulations very easy,
|
Material for MkDocs makes compliance with data privacy regulations very easy,
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
title: Extensions
|
title: Extensions
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Python Markdown Extensions
|
# Python Markdown Extensions
|
||||||
|
|
||||||
The [Python Markdown Extensions] package is an excellent collection of
|
The [Python Markdown Extensions] package is an excellent collection of
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Python Markdown
|
# Python Markdown
|
||||||
|
|
||||||
Material for MkDocs supports a large number of [Python Markdown] extensions,
|
Material for MkDocs supports a large number of [Python Markdown] extensions,
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
status: new
|
status: new
|
||||||
---
|
---
|
||||||
|
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Setting up navigation
|
# Setting up navigation
|
||||||
|
|
||||||
A clear and concise navigation structure is an important aspect of good project
|
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
|
# Setting up site analytics
|
||||||
|
|
||||||
As with any other service offered on the web, understanding how your project
|
As with any other service offered on the web, understanding how your project
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
---
|
---
|
||||||
template: overrides/main.html
|
|
||||||
search:
|
search:
|
||||||
boost: 1.05
|
boost: 1.05
|
||||||
---
|
---
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Setting up social cards
|
# Setting up social cards
|
||||||
|
|
||||||
Social cards, also known as social previews, are images that are displayed when
|
Social cards, also known as social previews, are images that are displayed when
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Setting up tags
|
# Setting up tags
|
||||||
|
|
||||||
Material for MkDocs adds first-class support for categorizing pages with 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
|
# Setting up the footer
|
||||||
|
|
||||||
The footer of your project documentation is a great place to add links to
|
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
|
# Setting up the header
|
||||||
|
|
||||||
Material for MkDocs' header can be customized to show an announcement bar that
|
Material for MkDocs' header can be customized to show an announcement bar that
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# Setting up versioning
|
# Setting up versioning
|
||||||
|
|
||||||
Material for MkDocs makes it easy to deploy multiple versions of your project
|
Material for MkDocs makes it easy to deploy multiple versions of your project
|
||||||
|
@ -1,7 +1,3 @@
|
|||||||
---
|
|
||||||
template: overrides/main.html
|
|
||||||
---
|
|
||||||
|
|
||||||
# How to upgrade
|
# How to upgrade
|
||||||
|
|
||||||
Upgrade to the latest version with:
|
Upgrade to the latest version with:
|
||||||
|
Loading…
Reference in New Issue
Block a user