Added documentation on footer setup

2024-11-24 07:30:12 +01:00 · 2020-10-11 12:20:36 +02:00 · 2020-10-11 12:20:36 +02:00 · 76a0b305ed
commit 76a0b305ed
parent 58cb2a2690
6 changed files with 65 additions and 56 deletions
--- a/docs/creating-your-site.md
+++ b/docs/creating-your-site.md
@ -72,7 +72,7 @@ icons and much more:
 * [Setting up site search][8]
 * [Setting up site analytics][9]
 * [Setting up the header][10]
-* [Adding social links][11]
+* [Setting up the footer][11]
 * [Adding a git repository][12]
 * [Adding a comment system][13]
 <!-- * [Adding a landing page][14] -->
@ -86,7 +86,7 @@ icons and much more:
  [8]: setup/setting-up-site-search.md
  [9]: setup/setting-up-site-analytics.md
  [10]: setup/setting-up-the-header.md
-  [11]: setup/adding-social-links.md
+  [11]: setup/setting-up-the-footer.md
  [12]: setup/adding-a-git-repository.md
  [13]: setup/adding-a-comment-system.md
  <!--[14]: setup/adding-a-landing-page.md-->
--- a/docs/insiders.md
+++ b/docs/insiders.md
@ -59,33 +59,33 @@ monthly subscription, which you can do at any time.__
 The following list shows which features are currently only available in Material
 for MkDocs Insiders. You can click on each feature to learn more about it:

- [x] [Support for user-toggleable themes (light/dark mode switch)][11]
- [x] [Highlighting of matched search terms in content area][12]
- [x] [Navigation can always be expanded via configuration][13]
- [x] [Header can be automatically hidden on scrolling][14]
- [x] [Table of contents can be automatically hidden when empty][15]
+- [x] [Remove _Made with Material for MkDocs_ from footer][11]
+- [x] [Support for user-toggleable themes (light/dark mode switch)][12]
+- [x] [Highlighting of matched search terms in content area][13]
+- [x] [Navigation can always be expanded via configuration][14]
+- [x] [Header can be automatically hidden on scrolling][15]
+- [x] [Table of contents can be automatically hidden when empty][16]

-  [11]: setup/changing-the-colors.md#color-palette-toggle
-  [12]: setup/setting-up-site-search.md#highlighting-search
-  [13]: setup/setting-up-navigation.md#navigation-expansion
-  [14]: setup/setting-up-the-header.md#automatic-hiding
-  [15]: setup/setting-up-navigation.md#automatic-hiding
+  [11]: setup/setting-up-the-footer.md#remove-generator
+  [12]: setup/changing-the-colors.md#color-palette-toggle
+  [13]: setup/setting-up-site-search.md#highlighting-search
+  [14]: setup/setting-up-navigation.md#navigation-expansion
+  [15]: setup/setting-up-the-header.md#automatic-hiding
+  [16]: setup/setting-up-navigation.md#automatic-hiding

 ## Roadmap

 The following list of funding goals – named after varieties of chili peppers 
-[I'm growing on my balcony][16] – shows which features are already available
+[I'm growing on my balcony][17] – shows which features are already available
 in Material for MkDocs Insiders.

-  [16]: https://www.instagram.com/squidfunk/
+  [17]: https://www.instagram.com/squidfunk/

-### Madame Jeanette
+### Madame Jeanette :octicons-check-24:

 [:octicons-flame-24: Funding goal: __$500__][6] ·
 :octicons-unlock-24: Status: _released_

-New features and improvements for _search_, including:
-
 - [x] Improved search result grouping (pages + headings)
 - [x] Improved search result relevance and scoring
 - [x] Display of missing query terms in search results
@ -95,12 +95,10 @@ New features and improvements for _search_, including:
 [:octicons-flame-24: Funding goal: __$1,000__][6] ·
 :octicons-lock-24: Status: _exclusive_

-New features and improvements for _content and toc_, including:
-
- [x] [Highlighting of matched search terms in content area][12]
- [x] [Navigation can always be expanded via configuration][13]
- [x] [Header can be automatically hidden on scrolling][14]
- [x] [Table of contents can be automatically hidden when empty][15]
+- [x] [Highlighting of matched search terms in content area][13]
+- [x] [Navigation can always be expanded via configuration][14]
+- [x] [Header can be automatically hidden on scrolling][15]
+- [x] [Table of contents can be automatically hidden when empty][16]
 - [ ] Table of contents can be moved into navigation for more space
 - [ ] Table of contents shows which sections have search results
 - [ ] Table of contents auto-collapses and expands only the active section
@ -111,8 +109,6 @@ New features and improvements for _content and toc_, including:
 [:octicons-flame-24: Funding goal: __$1,500__][6] ·
 :octicons-lock-24: Status: _exclusive_

-New features and improvements for _hosting multiple versions_, including:
-
 - [ ] Support for multiple languages of documents 
 - [ ] Support for multiple versions of documents
 - [ ] Support for one or more management plugins
@ -122,9 +118,7 @@ New features and improvements for _hosting multiple versions_, including:
 [:octicons-flame-24: Funding goal: __$2,000__][6] ·
 :octicons-lock-24: Status: _exclusive_

-New features and improvements for _user preferences_, including:
-
- [x] [Support for user-toggleable themes (light/dark mode switch)][11]
+- [x] [Support for user-toggleable themes (light/dark mode switch)][12]
 - [ ] Support for user-toggleable code-block styles (light/dark mode switch)

 ### Biquinho Vermelho
@ -132,8 +126,6 @@ New features and improvements for _user preferences_, including:
 [:octicons-flame-24: Funding goal: __$2,500__][6] ·
 :octicons-lock-24: Status: _exclusive_

-Even more features and improvements for _search_, including:
-
 - [ ] Support for search suggestions
 - [ ] Support for a user's last searches
 - [ ] Improved search result summaries
@ -143,9 +135,8 @@ Even more features and improvements for _search_, including:
 [:octicons-flame-24: Funding goal: __$3,000__][6] ·
 :octicons-lock-24: Status: _exclusive_

-Alternative, completely different _vertical layout_, optimized to read
-documentation and code side-by-side, e.g. for the documentation of APIs with
-the same functionality as Material for MkDocs.
+- [x] [Remove _Made with Material for MkDocs_ from footer][11]
+- [ ] Brand-new and exclusive vertical layout

 ## Frequently asked questions

@ -160,9 +151,11 @@ improvements (e.g. search) do not require any changes to existing configuration.
 This means that your users will be able to build the docs locally with the
 regular version and when they push their changes to CI/CD, they will be built
 with Material for MkDocs Insiders. For this reason, it's recommended to
-[install Insiders][17] only in CI, as you don't want to expose your `GH_TOKEN`
+[install Insiders][18] only in CI, as you don't want to expose your `GH_TOKEN`
 to users.

+  [18]: publishing-your-site.md#github-pages
+
 ### Terms

 _We're using Material for MkDocs to build the developer documentation of a
@ -171,7 +164,7 @@ terms?_

 Yes. Whether you're an individual or a company, you may use _Material for MkDocs
 Insiders_ precisely under the same terms as Material for MkDocs, which are given
-by the [MIT license][18]. However, we kindly ask you to respect the following
+by the [MIT license][19]. However, we kindly ask you to respect the following
 guidelines:

 - Please __don't distribute the source code__ from Material for MkDocs Insiders.
@ -182,8 +175,7 @@ guidelines:
 - If you cancel your subscription, you're removed as a collaborator and will
  miss out on future updates of Material for MkDocs Insiders. However, you may
  __use the latest version__ that's available to you __as long as you like__.
-  Just remember that __[GitHub deletes private forks][19]__.
+  Just remember that __[GitHub deletes private forks][20]__.

-  [17]: publishing-your-site.md#github-pages
-  [18]: license.md
-  [19]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
+  [19]: license.md
+  [20]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
--- a/docs/setup/setting-up-site-search.md
+++ b/docs/setup/setting-up-site-search.md
@ -19,7 +19,7 @@ made available [offline][1].
 [:octicons-cpu-24: Plugin][3]

 The [built-in search plugin][3] integrates seamlessly with Material for MkDocs,
-adding multilingual client-side search with [lunr][5] and [lunr-languages][6].
+adding multilingual client-side search with [lunr][4] and [lunr-languages][5].
 It's enabled by default, but must be re-added to `mkdocs.yml` when other plugins
 are used:

@ -33,9 +33,9 @@ The following options are supported:
 `lang`{: #lang }

 :   :octicons-milestone-24: Default: _automatically set_ – This option allows
-    to include the language-specific stemmers provided by [lunr-languages][6].
+    to include the language-specific stemmers provided by [lunr-languages][5].
    Note that Material for MkDocs will set this automatically based on the
-    [site language][7], but it may be overridden, e.g. to support multiple
+    [site language][6], but it may be overridden, e.g. to support multiple
    languages:

    === "A single language"
@ -105,7 +105,7 @@ The following options are supported:
 `prebuild_index`{: #prebuild-index }

 :   :octicons-milestone-24: Default: `false` · :octicons-beaker-24:
-    Experimental – MkDocs can generate a [prebuilt index][8] of all pages during
+    Experimental – MkDocs can generate a [prebuilt index][7] of all pages during
    build time, which provides performance improvements at the cost of more
    bandwidth, as it reduces the build time of the search index:

@ -125,18 +125,17 @@ them at your own risk._

  [2]: https://github.com/squidfunk/mkdocs-material/tree/master/src/assets/javascripts/integrations/search
  [3]: https://www.mkdocs.org/user-guide/configuration/#search
-  [4]: ../insiders.md
-  [5]: https://lunrjs.com
-  [6]: https://github.com/MihaiValentin/lunr-languages
-  [7]: changing-the-language.md#site-language
-  [8]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index
+  [4]: https://lunrjs.com
+  [5]: https://github.com/MihaiValentin/lunr-languages
+  [6]: changing-the-language.md#site-language
+  [7]: https://www.mkdocs.org/user-guide/configuration/#prebuild_index

 ### Highlighting search

-[:octicons-file-code-24: Source][4] ·
+[:octicons-file-code-24: Source][8] ·
 :octicons-unlock-24: Feature flag ·
 :octicons-beaker-24: Experimental ·
-[:octicons-heart-fill-24:{: .tx-heart } Insiders only][4]{: .tx-insiders }
+[:octicons-heart-fill-24:{: .tx-heart } Insiders only][8]{: .tx-insiders }

 When _search highlighting_ is activated and a user clicks on a search result,
 Material for MkDocs will highlight all occurrences after following the link.
@ -155,6 +154,7 @@ Searching for `"code blocks"` yields:
 _Give this feature a try on [the official documentation][10] built with Material
 for MkDocs Insiders!_

+  [8]: ../insiders.md
  [9]: ../assets/screenshots/search-highlighting.png
  [10]: https://squidfunk.github.io/mkdocs-material-insiders/reference/code-blocks/?h=code+blocks

--- a/docs/setup/setting-up-the-footer.md
+++ b/docs/setup/setting-up-the-footer.md
@ -2,7 +2,7 @@
 template: overrides/main.html
 ---

-# Adding social links
+# Setting up the footer

 The footer of your project documentation is a great place to add links to
 websites or platforms you or your company are using as additional marketing 
@ -89,6 +89,22 @@ For each entry, the following fields are available:
          name: squidfunk on Twitter
    ```

+### Remove generator
+
+[:octicons-file-code-24: Source][8] ·
+[:octicons-heart-fill-24:{: .tx-heart } Insiders only][8]{: .tx-insiders }
+
+The footer displays a __Made with Material for MkDocs__ notice to denote how
+the site was generated. The notice can be removed with the following setting
+via `mkdocs.yml`:
+
+``` yaml
+extra:
+  generator: false
+```
+
+  [8]: ../insiders.md
+
 ## Customization

 ### Custom icons
--- a/docs/upgrading.md
+++ b/docs/upgrading.md
@ -72,8 +72,8 @@ The templates have undergone a set of changes to make them future-proof. If
 you've used theme extension to override a block or template, make sure that it
 matches the new structure:

- If you've overridden a **block**, check `base.html` for potential changes
- If you've overridden a **template**, check the respective `*.html` file for
+- If you've overridden a __block__, check `base.html` for potential changes
+- If you've overridden a __template__, check the respective `*.html` file for
  potential changes

 ??? quote "`base.html`"
@ -433,8 +433,8 @@ The templates have undergone a set of changes to make them future-proof. If
 you've used theme extension to override a block or template, make sure that it 
 matches the new structure:

- If you've overridden a **block**, check `base.html` for potential changes
- If you've overridden a **template**, check the respective `*.html` file for
+- If you've overridden a __block__, check `base.html` for potential changes
+- If you've overridden a __template__, check the respective `*.html` file for
  potential changes

 ??? quote "`base.html`"
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -80,6 +80,7 @@ plugins:
        releases/4.md: upgrading.md #upgrading-from-4x-to-5x
        releases/5.md: upgrading.md #upgrading-from-3x-to-4x
        releases/changelog.md: changelog.md
+        setup/adding-social-links.md: setup/setting-up-the-footer.md
        sponsorship.md: insiders.md
  - minify:
      minify_html: true
@ -162,7 +163,7 @@ nav:
    - Setting up site search: setup/setting-up-site-search.md
    - Setting up site analytics: setup/setting-up-site-analytics.md
    - Setting up the header: setup/setting-up-the-header.md
-    - Adding social links: setup/adding-social-links.md
+    - Setting up the footer: setup/setting-up-the-footer.md
    - Adding a git repository: setup/adding-a-git-repository.md
    - Adding a comment system: setup/adding-a-comment-system.md
    #- Adding a landing page: setup/adding-a-landing-page.md