From 0f5cba40ac3d579422101c043a295f23f4ed703b Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 14 Nov 2021 08:46:35 +0100 Subject: [PATCH] Documentation --- docs/customization.md | 4 +--- docs/setup/adding-a-comment-system.md | 10 +++++----- docs/setup/extensions/python-markdown-extensions.md | 6 +++--- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index 0793f26b0..ae39875f4 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -103,6 +103,7 @@ assets may also be put in the `overrides` directory: │ │ ├─ analytics/ # Analytics integrations │ │ └─ analytics.html # Analytics setup │ ├─ languages/ # Translation languages +│ ├─ content.html # Page content │ ├─ copyright.html # Copyright and theme information │ ├─ footer.html # Footer bar │ ├─ header.html # Header bar @@ -110,9 +111,6 @@ assets may also be put in the `overrides` directory: │ ├─ logo.html # Logo in header and sidebar │ ├─ nav.html # Main navigation │ ├─ nav-item.html # Main navigation item -│ ├─ page.html # Page -│ ├─ page-footer.html # Page footer -│ ├─ page-header.html # Page header │ ├─ palette.html # Color palette │ ├─ search.html # Search interface │ ├─ social.html # Social links diff --git a/docs/setup/adding-a-comment-system.md b/docs/setup/adding-a-comment-system.md index 7ab268746..ddc3de5ae 100644 --- a/docs/setup/adding-a-comment-system.md +++ b/docs/setup/adding-a-comment-system.md @@ -17,13 +17,13 @@ can be integrate with the same principles In order to integrate a third-party comment provider offering a JavaScript-based solution, follow the guide on [theme extension], copy the contents from the -[`page-footer.html`][page-footer partial] partial and create a file -at the same location in the `overrides` folder: +[`content.html`][content partial] partial and create a file at the same location +in the `overrides` folder: -=== ":octicons-file-code-16: overrides/partials/page-footer.html" +=== ":octicons-file-code-16: overrides/partials/content.html" ``` html - + {% set disqus = config.extra.disqus %} @@ -75,7 +75,7 @@ at the same location in the `overrides` folder: 1. Add your Disqus [shortname] here. [theme extension]: ../customization.md#extending-the-theme - [page-footer partial]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/page-footer.html + [content partial]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/content.html [shortname]: https://help.disqus.com/en/articles/1717111-what-s-a-shortname #### on a single page diff --git a/docs/setup/extensions/python-markdown-extensions.md b/docs/setup/extensions/python-markdown-extensions.md index a596e052a..67bda2e46 100644 --- a/docs/setup/extensions/python-markdown-extensions.md +++ b/docs/setup/extensions/python-markdown-extensions.md @@ -399,9 +399,9 @@ The following configuration options are supported: `linenums_style`{ #highlight-linenums-style } : :octicons-milestone-24: Default: `table` – The [Highlight] extension - provides three ways to add line numbers, all of which are supported by - Material for MkDocs. While `table` wraps a code block in a table, `inline` - and `pymdownx-inline` render line numbers as part of the line itself: + provides three ways to add line numbers, two of which are supported by + Material for MkDocs. While `table` wraps a code block in a `` + element, `pymdownx-inline` renders line numbers as part of the line itself: ``` yaml markdown_extensions: