OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2021-11-14 08:46:35 +01:00
parent b4e0467878
commit 0f5cba40ac
3 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/customization.md
View File

@ -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

10
docs/setup/adding-a-comment-system.md
View File

@ -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
<!-- Add copied contents from original page-footer.html here -->
<!-- Add copied contents from original content.html here -->
<!-- Get setting from mkdocs.yml, but allow page-level overrides -->
{% 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

6
docs/setup/extensions/python-markdown-extensions.md
View File

@ -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 `<table>`
element, `pymdownx-inline` renders line numbers as part of the line itself:
``` yaml
markdown_extensions: