Skip to content

Commit 080fccd

Browse files
committed
Documentation
1 parent 4caa165 commit 080fccd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+21
-137
lines changed

docs/alternatives.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Alternatives
62

73
There are tons of static site generators and themes out there and choosing the

docs/browser-support.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Browser support
62

73
Material for MkDocs goes at great lengths to support the largest possible range

docs/changelog/index.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changelog
62

73
## Material for MkDocs

docs/creating-your-site.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Creating your site
62

73
After you've [installed] Material for MkDocs, you can bootstrap your project

docs/customization.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Customization
62

73
Project documentation is as diverse as the projects themselves and Material for

docs/getting-started.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Getting started
62

73
Material for MkDocs is a theme for [MkDocs], a static site generator geared

docs/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
---
2-
template: overrides/home.html
2+
template: home.html
33
title: Material for MkDocs
44
---
5+
6+
Welcome to Material for MkDocs.

docs/insiders/changelog.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changelog
62

73
## Material for MkDocs Insiders

docs/insiders/getting-started.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
title: Getting started with Insiders
43
---
54

docs/insiders/index.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
title: Insiders
43
---
54

docs/license.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# License
62

73
**MIT License**

docs/philosophy.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Philosophy
62

73
Before settling for Material for MkDocs, it's a good idea to understand the

docs/publishing-your-site.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Publishing your site
62

73
The great thing about hosting project documentation in a `git` repository is

docs/reference/admonitions.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/alert-outline
43
---
54

docs/reference/annotations.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/plus-circle
43
---
54

docs/reference/buttons.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/gesture-tap-button
43
---
54

docs/reference/code-blocks.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/code-json
43
---
54

docs/reference/content-tabs.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/tab
43
---
54

docs/reference/data-tables.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/table-edit
43
---
54

docs/reference/diagrams.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/graph-outline
43
---
54

docs/reference/footnotes.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/format-align-bottom
43
---
54

docs/reference/formatting.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/format-font
43
---
54

docs/reference/grids.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/view-grid-plus
43
---
54

docs/reference/icons-emojis.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/emoticon-happy-outline
43
---
54

docs/reference/images.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/image-frame
43
---
54

docs/reference/index.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Reference
62

73
Material for MkDocs is packed with many great features that make technical

docs/reference/lists.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/format-list-bulleted
43
---
54

docs/reference/mathjax.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/alphabet-greek
43
---
54

docs/reference/tooltips.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
template: overrides/main.html
32
icon: material/tooltip-plus
43
status: new
54
---

docs/schema/assets/icons.json

+18
Original file line numberDiff line numberDiff line change
@@ -9872,6 +9872,7 @@
98729872
"simple/azurefunctions",
98739873
"simple/azurepipelines",
98749874
"simple/babel",
9875+
"simple/backblaze",
98759876
"simple/backbonedotjs",
98769877
"simple/backendless",
98779878
"simple/badgr",
@@ -9905,6 +9906,8 @@
99059906
"simple/bigcartel",
99069907
"simple/bigcommerce",
99079908
"simple/bilibili",
9909+
"simple/billboard",
9910+
"simple/bim",
99089911
"simple/binance",
99099912
"simple/biolink",
99109913
"simple/bit",
@@ -10112,6 +10115,7 @@
1011210115
"simple/cplusplus",
1011310116
"simple/craftcms",
1011410117
"simple/cratedb",
10118+
"simple/crayon",
1011510119
"simple/createreactapp",
1011610120
"simple/creativecommons",
1011710121
"simple/credly",
@@ -10215,6 +10219,7 @@
1021510219
"simple/dotnet",
1021610220
"simple/douban",
1021710221
"simple/doubanread",
10222+
"simple/dovecot",
1021810223
"simple/dpd",
1021910224
"simple/dragonframe",
1022010225
"simple/draugiemdotlv",
@@ -10275,6 +10280,7 @@
1027510280
"simple/emirates",
1027610281
"simple/emlakjet",
1027710282
"simple/empirekred",
10283+
"simple/engadget",
1027810284
"simple/enpass",
1027910285
"simple/enterprisedb",
1028010286
"simple/envato",
@@ -10347,6 +10353,7 @@
1034710353
"simple/firebase",
1034810354
"simple/firefox",
1034910355
"simple/firefoxbrowser",
10356+
"simple/fireship",
1035010357
"simple/first",
1035110358
"simple/fitbit",
1035210359
"simple/fite",
@@ -10382,6 +10389,7 @@
1038210389
"simple/fossilscm",
1038310390
"simple/foursquare",
1038410391
"simple/foursquarecityguide",
10392+
"simple/fox",
1038510393
"simple/foxtel",
1038610394
"simple/fozzy",
1038710395
"simple/framer",
@@ -10516,6 +10524,7 @@
1051610524
"simple/groupon",
1051710525
"simple/grubhub",
1051810526
"simple/grunt",
10527+
"simple/gsk",
1051910528
"simple/gtk",
1052010529
"simple/guangzhoumetro",
1052110530
"simple/guilded",
@@ -10550,6 +10559,7 @@
1055010559
"simple/hcl",
1055110560
"simple/headlessui",
1055210561
"simple/headspace",
10562+
"simple/hedera",
1055310563
"simple/hellofresh",
1055410564
"simple/hellyhansen",
1055510565
"simple/helm",
@@ -10637,6 +10647,7 @@
1063710647
"simple/instapaper",
1063810648
"simple/instatus",
1063910649
"simple/instructables",
10650+
"simple/instructure",
1064010651
"simple/integromat",
1064110652
"simple/intel",
1064210653
"simple/intellijidea",
@@ -10963,6 +10974,7 @@
1096310974
"simple/monster",
1096410975
"simple/monzo",
1096510976
"simple/moo",
10977+
"simple/moonrepo",
1096610978
"simple/morrisons",
1096710979
"simple/moscowmetro",
1096810980
"simple/motorola",
@@ -11151,10 +11163,12 @@
1115111163
"simple/pelican",
1115211164
"simple/peloton",
1115311165
"simple/penny",
11166+
"simple/penpot",
1115411167
"simple/pepsi",
1115511168
"simple/percy",
1115611169
"simple/perforce",
1115711170
"simple/perl",
11171+
"simple/persistent",
1115811172
"simple/personio",
1115911173
"simple/petsathome",
1116011174
"simple/peugeot",
@@ -11285,6 +11299,7 @@
1128511299
"simple/pypi",
1128611300
"simple/pypy",
1128711301
"simple/pyscaffold",
11302+
"simple/pysyft",
1128811303
"simple/pytest",
1128911304
"simple/python",
1129011305
"simple/pytorch",
@@ -11403,6 +11418,7 @@
1140311418
"simple/rotaryinternational",
1140411419
"simple/rottentomatoes",
1140511420
"simple/roundcube",
11421+
"simple/rsocket",
1140611422
"simple/rss",
1140711423
"simple/rstudio",
1140811424
"simple/rte",
@@ -11652,6 +11668,7 @@
1165211668
"simple/symphony",
1165311669
"simple/sympy",
1165411670
"simple/synology",
11671+
"simple/system76",
1165511672
"simple/tableau",
1165611673
"simple/tablecheck",
1165711674
"simple/tacobell",
@@ -11945,6 +11962,7 @@
1194511962
"simple/workplace",
1194611963
"simple/worldhealthorganization",
1194711964
"simple/wpengine",
11965+
"simple/wpexplorer",
1194811966
"simple/wprocket",
1194911967
"simple/writedotas",
1195011968
"simple/wwe",

docs/setup/adding-a-comment-system.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Adding a comment system
62

73
Material for MkDocs allows to easily add the third-party comment system of your

docs/setup/adding-a-git-repository.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Adding a git repository
62

73
If your documentation is related to source code, Material for MkDocs provides

docs/setup/building-for-offline-usage.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Building for offline usage
62

73
If you want to ship your documentation together with your product, MkDocs has

docs/setup/changing-the-colors.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changing the colors
62

73
As any proper Material Design implementation, Material for MkDocs supports

docs/setup/changing-the-fonts.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changing the fonts
62

73
Material for MkDocs makes it easy to change the typeface of your project

docs/setup/changing-the-language.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changing the language
62

73
Material for MkDocs supports internationalization (i18n) and provides

docs/setup/changing-the-logo-and-icons.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Changing the logo and icons
62

73
When installing Material for MkDocs, you immediately get access to _over 8,000

docs/setup/ensuring-data-privacy.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
template: overrides/main.html
3-
---
4-
51
# Ensuring data privacy
62

73
Material for MkDocs makes compliance with data privacy regulations very easy,

0 commit comments

Comments
 (0)