Added ids to options

This commit is contained in:
squidfunk 2020-07-22 14:05:07 +02:00
parent ae1cc68a4e
commit 71b875be1a
6 changed files with 17 additions and 17 deletions

View File

@ -22,7 +22,7 @@ The [Highlight][3] extension, which is part of [Python Markdown Extensions][5],
integrates with Material for MkDocs and provides several options for
configuring syntax highlighting of code blocks:
`use_pygments`
`use_pygments`{: #use_pygments }
: :octicons-milestone-24: Default: `true` This option allows to control
whether highlighting should be carried out during build time by
@ -71,7 +71,7 @@ configuring syntax highlighting of code blocks:
Note that Highlight.js has no affiliation with the Highlight extension.
`linenums`
`linenums`{: #linenums }
: :octicons-milestone-24: Default: `false` This option will add line numbers
to _all_ code blocks. If you wish to add line numbers to _some_, but not all
@ -84,7 +84,7 @@ configuring syntax highlighting of code blocks:
linenums: true
```
`linenums_style`
`linenums_style`{: #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

View File

@ -35,7 +35,7 @@ The [Tasklist][4] extension, which is part of [Python Markdown Extensions][5],
adds support for lists with styled checkboxes, and provides several options for
configuring the style:
`custom_checkbox`
`custom_checkbox`{: #custom_checkbox }
: :octicons-milestone-24: Default: `false` · This option toggles the rendering
style of checkboxes, replacing native checkbox styles with beautiful icons,
@ -47,7 +47,7 @@ configuring the style:
custom_checkbox: true
```
`clickable_checkbox`
`clickable_checkbox`{: #clickable_checkbox }
: :octicons-milestone-24: Default: `false` · This option toggles whether
checkboxes are clickable. As the state is not persisted, the use of this

View File

@ -31,7 +31,7 @@ extra:
For each entry, the following fields are available:
`icon`
`icon`{: #icon }
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required
This field must point to a valid icon path referencing [any icon bundled
@ -51,7 +51,7 @@ For each entry, the following fields are available:
[1]: https://github.com/squidfunk/mkdocs-material/blob/master/src/partials/social.html
[2]: https://github.com/squidfunk/mkdocs-material/tree/master/material/.icons
`link`
`link`{: #link }
: :octicons-milestone-24: Default: _none_ · :octicons-alert-24: Required
This field must contain a valid relative or absolute URL including the URI
@ -75,7 +75,7 @@ For each entry, the following fields are available:
link: mailto:<email-address>
```
`name`
`name`{: #name }
: :octicons-milestone-24: Default: _domain name from_ `link`_, if available_
This field is used as the link's `title` attribute and can be set to a

View File

@ -103,7 +103,7 @@ The [Table of contents][8] extension, which is part of the standard Markdown
library, provides some options that are supported by Material for MkDocs to
customize its appearance:
`permalink`
`permalink`{: #permalink }
: :octicons-milestone-24: Default: `false` This option adds an anchor link
containing the paragraph symbol `¶` or another custom symbol at the end of
@ -126,7 +126,7 @@ customize its appearance:
permalink: ⚓︎
```
`slugify`
`slugify`{: #slugify }
: :octicons-milestone-24: Default: `headerid.slugify` This option allows for
customization of the slug function. For some languages, the default may not
@ -149,7 +149,7 @@ customize its appearance:
slugify: pymdownx.slugs.uslugify_cased
```
`toc_depth`
`toc_depth`{: #toc_depth }
: :octicons-milestone-24: Default: `6` Define the range of levels to be
included in the table of contents. This may be useful for project

View File

@ -30,7 +30,7 @@ plugins:
The following options are supported:
`lang`
`lang`{: #lang }
: :octicons-milestone-24: Default: _automatically set_ This option allows
to include the language-specific stemmers provided by [lunr-languages][5].
@ -89,7 +89,7 @@ The following options are supported:
JavaScript payload by around 20kb (before `gzip`) and by another 15-30kb
per language.
`separator`
`separator`{: #separator }
: :octicons-milestone-24: Default: _automatically set_ The separator for
indexing and query tokenization can be customized, which makes it possible
@ -102,7 +102,7 @@ The following options are supported:
separator: '[\s\-\.]+'
```
`prebuild_index`
`prebuild_index`{: #prebuild_index }
: :octicons-milestone-24: Default: `false` · :octicons-beaker-24:
Experimental MkDocs can generate a [prebuilt index][7] of all pages during

View File

@ -73,13 +73,13 @@ plugins:
extensions/codehilite.md: reference/code-blocks.md
extensions/footnotes.md: reference/footnotes.md
extensions/metadata.md: reference/meta-tags.md
extensions/permalinks.md: setup/setting-up-navigation.md
extensions/permalinks.md: setup/setting-up-navigation.md #permalink
plugins/search.md: setup/setting-up-site-search.md
# plugins/minification.md:
# plugins/revision-date.md:
# plugins/awesome-pages.md:
releases/4.md: upgrading.md
releases/5.md: upgrading.md
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
- minify:
minify_html: true