Changed pymdownx.inline to pymdownx-inline (#2633)

Co-authored-by: r4c12 <r4c12_zn@163.com>
This commit is contained in:
ning 2021-05-04 17:13:15 +08:00 committed by GitHub
parent e3c3b71412
commit 26d00333b0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -91,18 +91,18 @@ configuring syntax highlighting of code blocks:
: :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:
`pymdownx-inline` render line numbers as part of the line itself:
``` yaml
markdown_extensions:
- pymdownx.highlight:
linenums_style: pymdownx.inline
linenums_style: pymdownx-inline
```
Note that `inline` will put line numbers next to the actual code, which
means that they will be included when selecting text with the cursor or
copying a code block to the clipboard. Thus, the usage of `table` or
`pymdownx.inline` is recommended.
`pymdownx-inline` is recommended.
_Material for MkDocs doesn't provide official support for the other options of
this extension, so they may be supported but might yield unexpected results.