From 080fccd65a93df3c8744af62b403449efa9fc058 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Tue, 1 Nov 2022 12:41:27 +0700 Subject: [PATCH] Documentation --- docs/alternatives.md | 4 ---- docs/browser-support.md | 4 ---- docs/changelog/index.md | 4 ---- docs/creating-your-site.md | 4 ---- docs/customization.md | 4 ---- docs/getting-started.md | 4 ---- docs/index.md | 4 +++- docs/insiders/changelog.md | 4 ---- docs/insiders/getting-started.md | 1 - docs/insiders/index.md | 1 - docs/license.md | 4 ---- docs/philosophy.md | 4 ---- docs/publishing-your-site.md | 4 ---- docs/reference/admonitions.md | 1 - docs/reference/annotations.md | 1 - docs/reference/buttons.md | 1 - docs/reference/code-blocks.md | 1 - docs/reference/content-tabs.md | 1 - docs/reference/data-tables.md | 1 - docs/reference/diagrams.md | 1 - docs/reference/footnotes.md | 1 - docs/reference/formatting.md | 1 - docs/reference/grids.md | 1 - docs/reference/icons-emojis.md | 1 - docs/reference/images.md | 1 - docs/reference/index.md | 4 ---- docs/reference/lists.md | 1 - docs/reference/mathjax.md | 1 - docs/reference/tooltips.md | 1 - docs/schema/assets/icons.json | 18 ++++++++++++++++++ docs/setup/adding-a-comment-system.md | 4 ---- docs/setup/adding-a-git-repository.md | 4 ---- docs/setup/building-for-offline-usage.md | 4 ---- docs/setup/changing-the-colors.md | 4 ---- docs/setup/changing-the-fonts.md | 4 ---- docs/setup/changing-the-language.md | 4 ---- docs/setup/changing-the-logo-and-icons.md | 4 ---- docs/setup/ensuring-data-privacy.md | 4 ---- docs/setup/extensions/index.md | 1 - .../extensions/python-markdown-extensions.md | 4 ---- docs/setup/extensions/python-markdown.md | 4 ---- docs/setup/setting-up-a-blog.md | 1 - docs/setup/setting-up-navigation.md | 4 ---- docs/setup/setting-up-site-analytics.md | 4 ---- docs/setup/setting-up-site-search.md | 1 - docs/setup/setting-up-social-cards.md | 4 ---- docs/setup/setting-up-tags.md | 4 ---- docs/setup/setting-up-the-footer.md | 4 ---- docs/setup/setting-up-the-header.md | 4 ---- docs/setup/setting-up-versioning.md | 4 ---- docs/upgrade.md | 4 ---- 51 files changed, 21 insertions(+), 137 deletions(-) diff --git a/docs/alternatives.md b/docs/alternatives.md index 77a8dd274..f3afe6dcb 100644 --- a/docs/alternatives.md +++ b/docs/alternatives.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Alternatives There are tons of static site generators and themes out there and choosing the diff --git a/docs/browser-support.md b/docs/browser-support.md index 11879b706..e5e3cece8 100644 --- a/docs/browser-support.md +++ b/docs/browser-support.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Browser support Material for MkDocs goes at great lengths to support the largest possible range diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 8fbc1513a..acf3dd487 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Changelog ## Material for MkDocs diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index 6bab4ea08..c8123802b 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Creating your site After you've [installed] Material for MkDocs, you can bootstrap your project diff --git a/docs/customization.md b/docs/customization.md index 58f469d3a..e7e4baa05 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Customization Project documentation is as diverse as the projects themselves and Material for diff --git a/docs/getting-started.md b/docs/getting-started.md index a0bb59369..12215786a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Getting started Material for MkDocs is a theme for [MkDocs], a static site generator geared diff --git a/docs/index.md b/docs/index.md index ad49ab437..ff0136314 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,6 @@ --- -template: overrides/home.html +template: home.html title: Material for MkDocs --- + +Welcome to Material for MkDocs. \ No newline at end of file diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 3e3a26349..5e8d179df 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Changelog ## Material for MkDocs Insiders diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 42d1f5a9c..8b8157dfe 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html title: Getting started with Insiders --- diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 4829ccb71..3436a53d9 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html title: Insiders --- diff --git a/docs/license.md b/docs/license.md index bb0712d76..7f736e77b 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # License **MIT License** diff --git a/docs/philosophy.md b/docs/philosophy.md index 6821c121c..41a01ca1e 100644 --- a/docs/philosophy.md +++ b/docs/philosophy.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Philosophy Before settling for Material for MkDocs, it's a good idea to understand the diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index faeec48ae..6090e6ce6 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Publishing your site The great thing about hosting project documentation in a `git` repository is diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index 15408aef7..f2121ed5c 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/alert-outline --- diff --git a/docs/reference/annotations.md b/docs/reference/annotations.md index db02e514e..8d15e3d07 100644 --- a/docs/reference/annotations.md +++ b/docs/reference/annotations.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/plus-circle --- diff --git a/docs/reference/buttons.md b/docs/reference/buttons.md index 4e72eb0d1..72b8dcbc7 100644 --- a/docs/reference/buttons.md +++ b/docs/reference/buttons.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/gesture-tap-button --- diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index be358e8f9..c2f09a535 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/code-json --- diff --git a/docs/reference/content-tabs.md b/docs/reference/content-tabs.md index 7e15ecf9d..15fe47c73 100644 --- a/docs/reference/content-tabs.md +++ b/docs/reference/content-tabs.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/tab --- diff --git a/docs/reference/data-tables.md b/docs/reference/data-tables.md index 100cecc34..03b91d6a9 100644 --- a/docs/reference/data-tables.md +++ b/docs/reference/data-tables.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/table-edit --- diff --git a/docs/reference/diagrams.md b/docs/reference/diagrams.md index 590600f67..d6ce3a995 100644 --- a/docs/reference/diagrams.md +++ b/docs/reference/diagrams.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/graph-outline --- diff --git a/docs/reference/footnotes.md b/docs/reference/footnotes.md index c5a4aa470..16380c2cb 100644 --- a/docs/reference/footnotes.md +++ b/docs/reference/footnotes.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/format-align-bottom --- diff --git a/docs/reference/formatting.md b/docs/reference/formatting.md index f3ca2e428..7dec1ca69 100644 --- a/docs/reference/formatting.md +++ b/docs/reference/formatting.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/format-font --- diff --git a/docs/reference/grids.md b/docs/reference/grids.md index 6c4554342..021394d3f 100644 --- a/docs/reference/grids.md +++ b/docs/reference/grids.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/view-grid-plus --- diff --git a/docs/reference/icons-emojis.md b/docs/reference/icons-emojis.md index e2d824141..2bae6e6a7 100644 --- a/docs/reference/icons-emojis.md +++ b/docs/reference/icons-emojis.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/emoticon-happy-outline --- diff --git a/docs/reference/images.md b/docs/reference/images.md index 88192bd9c..cbb30f2bb 100644 --- a/docs/reference/images.md +++ b/docs/reference/images.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/image-frame --- diff --git a/docs/reference/index.md b/docs/reference/index.md index 08e8beb12..4cd5b6247 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Reference Material for MkDocs is packed with many great features that make technical diff --git a/docs/reference/lists.md b/docs/reference/lists.md index d73885b00..5883002a7 100644 --- a/docs/reference/lists.md +++ b/docs/reference/lists.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/format-list-bulleted --- diff --git a/docs/reference/mathjax.md b/docs/reference/mathjax.md index 960828465..f41074402 100644 --- a/docs/reference/mathjax.md +++ b/docs/reference/mathjax.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/alphabet-greek --- diff --git a/docs/reference/tooltips.md b/docs/reference/tooltips.md index efdebb339..5b4e7f642 100644 --- a/docs/reference/tooltips.md +++ b/docs/reference/tooltips.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html icon: material/tooltip-plus status: new --- diff --git a/docs/schema/assets/icons.json b/docs/schema/assets/icons.json index f280fb732..918d106a0 100644 --- a/docs/schema/assets/icons.json +++ b/docs/schema/assets/icons.json @@ -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", diff --git a/docs/setup/adding-a-comment-system.md b/docs/setup/adding-a-comment-system.md index fd91ed30a..9fad62546 100644 --- a/docs/setup/adding-a-comment-system.md +++ b/docs/setup/adding-a-comment-system.md @@ -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 diff --git a/docs/setup/adding-a-git-repository.md b/docs/setup/adding-a-git-repository.md index e4ec5a7b9..e14cf940a 100644 --- a/docs/setup/adding-a-git-repository.md +++ b/docs/setup/adding-a-git-repository.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Adding a git repository If your documentation is related to source code, Material for MkDocs provides diff --git a/docs/setup/building-for-offline-usage.md b/docs/setup/building-for-offline-usage.md index 038fb1320..1ff53c1d6 100644 --- a/docs/setup/building-for-offline-usage.md +++ b/docs/setup/building-for-offline-usage.md @@ -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 diff --git a/docs/setup/changing-the-colors.md b/docs/setup/changing-the-colors.md index a40d45aa8..55c880123 100644 --- a/docs/setup/changing-the-colors.md +++ b/docs/setup/changing-the-colors.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Changing the colors As any proper Material Design implementation, Material for MkDocs supports diff --git a/docs/setup/changing-the-fonts.md b/docs/setup/changing-the-fonts.md index ab8a5d239..b671376af 100644 --- a/docs/setup/changing-the-fonts.md +++ b/docs/setup/changing-the-fonts.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Changing the fonts Material for MkDocs makes it easy to change the typeface of your project diff --git a/docs/setup/changing-the-language.md b/docs/setup/changing-the-language.md index 598f53dd5..7cdf1d587 100644 --- a/docs/setup/changing-the-language.md +++ b/docs/setup/changing-the-language.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Changing the language Material for MkDocs supports internationalization (i18n) and provides diff --git a/docs/setup/changing-the-logo-and-icons.md b/docs/setup/changing-the-logo-and-icons.md index 57cbcc9c6..1478fa488 100644 --- a/docs/setup/changing-the-logo-and-icons.md +++ b/docs/setup/changing-the-logo-and-icons.md @@ -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 diff --git a/docs/setup/ensuring-data-privacy.md b/docs/setup/ensuring-data-privacy.md index 198398fa7..c295940d6 100644 --- a/docs/setup/ensuring-data-privacy.md +++ b/docs/setup/ensuring-data-privacy.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Ensuring data privacy Material for MkDocs makes compliance with data privacy regulations very easy, diff --git a/docs/setup/extensions/index.md b/docs/setup/extensions/index.md index 8fd02f6e3..db440bc34 100644 --- a/docs/setup/extensions/index.md +++ b/docs/setup/extensions/index.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html title: Extensions --- diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index c32c410b0..4e3e744da 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Python Markdown Extensions The [Python Markdown Extensions] package is an excellent collection of diff --git a/docs/setup/extensions/python-markdown.md b/docs/setup/extensions/python-markdown.md index 4278116d1..0c581b6a7 100644 --- a/docs/setup/extensions/python-markdown.md +++ b/docs/setup/extensions/python-markdown.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Python Markdown Material for MkDocs supports a large number of [Python Markdown] extensions, diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index 362932fb8..5162bffe7 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html status: new --- diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index d1863861e..0ac14e9e3 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Setting up navigation A clear and concise navigation structure is an important aspect of good project diff --git a/docs/setup/setting-up-site-analytics.md b/docs/setup/setting-up-site-analytics.md index 50371d093..9ec16ca0c 100644 --- a/docs/setup/setting-up-site-analytics.md +++ b/docs/setup/setting-up-site-analytics.md @@ -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 diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index 93a1f4390..e829138ff 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -1,5 +1,4 @@ --- -template: overrides/main.html search: boost: 1.05 --- diff --git a/docs/setup/setting-up-social-cards.md b/docs/setup/setting-up-social-cards.md index e11a184eb..b89206d23 100644 --- a/docs/setup/setting-up-social-cards.md +++ b/docs/setup/setting-up-social-cards.md @@ -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 diff --git a/docs/setup/setting-up-tags.md b/docs/setup/setting-up-tags.md index 518df0ef8..ba847362f 100644 --- a/docs/setup/setting-up-tags.md +++ b/docs/setup/setting-up-tags.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Setting up tags Material for MkDocs adds first-class support for categorizing pages with tags, diff --git a/docs/setup/setting-up-the-footer.md b/docs/setup/setting-up-the-footer.md index 2fc2cc057..c0954be62 100644 --- a/docs/setup/setting-up-the-footer.md +++ b/docs/setup/setting-up-the-footer.md @@ -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 diff --git a/docs/setup/setting-up-the-header.md b/docs/setup/setting-up-the-header.md index b119cc85e..9a9009436 100644 --- a/docs/setup/setting-up-the-header.md +++ b/docs/setup/setting-up-the-header.md @@ -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 diff --git a/docs/setup/setting-up-versioning.md b/docs/setup/setting-up-versioning.md index 4641dbc23..aee3acaf4 100644 --- a/docs/setup/setting-up-versioning.md +++ b/docs/setup/setting-up-versioning.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # Setting up versioning Material for MkDocs makes it easy to deploy multiple versions of your project diff --git a/docs/upgrade.md b/docs/upgrade.md index 5fb030ceb..fe9ad9ab1 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -1,7 +1,3 @@ ---- -template: overrides/main.html ---- - # How to upgrade Upgrade to the latest version with: