mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Added documentation for changing annotation width
This commit is contained in:
parent
d4c80075e8
commit
9f01a6664b
@ -59,14 +59,13 @@ the following older browser versions might work with some additional effort:
|
|||||||
|
|
||||||
- :fontawesome-brands-firefox: __Firefox 31-52__ – icons will render as little
|
- :fontawesome-brands-firefox: __Firefox 31-52__ – icons will render as little
|
||||||
boxes due to missing support for [mask images]. While this cannot be
|
boxes due to missing support for [mask images]. While this cannot be
|
||||||
polyfilled, it might be mitigated by hiding icons with [additional CSS].
|
polyfilled, it might be mitigated by hiding the icons altogether.
|
||||||
- :fontawesome-brands-edge: __Edge 16-18__ – the spacing of some elements might be
|
- :fontawesome-brands-edge: __Edge 16-18__ – the spacing of some elements might
|
||||||
a little off due to missing support for the [:is pseudo selector], which can be
|
be a little off due to missing support for the [:is pseudo selector], which
|
||||||
mitigated with some [additional CSS].
|
can be mitigated with some additional effort.
|
||||||
- :fontawesome-brands-internet-explorer: __Internet Explorer__ - no support,
|
- :fontawesome-brands-internet-explorer: __Internet Explorer__ - no support,
|
||||||
mainly due to missing support for [custom properties]. The last version of
|
mainly due to missing support for [custom properties]. The last version of
|
||||||
Material for MkDocs to support Internet Explorer is
|
Material for MkDocs to support Internet Explorer is
|
||||||
[:octicons-tag-24: 4.6.3][IE support].
|
[:octicons-tag-24: 4.6.3][IE support].
|
||||||
|
|
||||||
[additional CSS]: customization.md#additional-css
|
|
||||||
[IE support]: https://github.com/squidfunk/mkdocs-material/releases/tag/4.6.3
|
[IE support]: https://github.com/squidfunk/mkdocs-material/releases/tag/4.6.3
|
||||||
|
@ -396,6 +396,39 @@ override it as part of your [additional style sheet]:
|
|||||||
[additional style sheet]: ../customization.md#additional-css
|
[additional style sheet]: ../customization.md#additional-css
|
||||||
[syntax theme definition]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/extensions/pymdownx/_highlight.scss
|
[syntax theme definition]: https://github.com/squidfunk/mkdocs-material/blob/master/src/assets/stylesheets/main/extensions/pymdownx/_highlight.scss
|
||||||
|
|
||||||
|
### Annotation tooltip width
|
||||||
|
|
||||||
|
If you have a lot of content hosted inside your code annotations, it can be a
|
||||||
|
good idea to increase the width of the tooltip by adding the following as part
|
||||||
|
of an [additional style sheet]:
|
||||||
|
|
||||||
|
=== ":octicons-file-code-16: docs/stylesheets/extra.css"
|
||||||
|
|
||||||
|
``` css
|
||||||
|
:root {
|
||||||
|
--md-tooltip-width: 600px;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
=== ":octicons-file-code-16: mkdocs.yml"
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
extra_css:
|
||||||
|
- stylesheets/extra.css
|
||||||
|
```
|
||||||
|
|
||||||
|
This will render annotations with a larger width:
|
||||||
|
|
||||||
|
<div style="--md-tooltip-width: 600px;" markdown>
|
||||||
|
|
||||||
|
``` yaml
|
||||||
|
# (1)!
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Muuuuuuuuuuuuuuuch more space for content
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
### Annotations with numbers
|
### Annotations with numbers
|
||||||
|
|
||||||
Prior to [:octicons-tag-24: 8.1.0][code annotation markers], code annotations
|
Prior to [:octicons-tag-24: 8.1.0][code annotation markers], code annotations
|
||||||
|
@ -343,8 +343,8 @@ The following configuration options are supported:
|
|||||||
```
|
```
|
||||||
|
|
||||||
As an example, [Highlight.js], a JavaScript syntax highlighter, can be
|
As an example, [Highlight.js], a JavaScript syntax highlighter, can be
|
||||||
integrated with some [additional JavaScript] and [additional CSS] in
|
integrated with some [additional JavaScript] and an [additional style
|
||||||
`mkdocs.yml`:
|
sheet] in `mkdocs.yml`:
|
||||||
|
|
||||||
=== ":octicons-file-code-16: docs/javascripts/highlight.js"
|
=== ":octicons-file-code-16: docs/javascripts/highlight.js"
|
||||||
|
|
||||||
@ -446,7 +446,7 @@ See reference for usage:
|
|||||||
[pymdownx.superfences]: #superfences
|
[pymdownx.superfences]: #superfences
|
||||||
[pymdownx.inlinehilite]: #inlinehilite
|
[pymdownx.inlinehilite]: #inlinehilite
|
||||||
[Pygments]: https://pygments.org
|
[Pygments]: https://pygments.org
|
||||||
[additional CSS]: ../../customization.md#additional-css
|
[additional style sheet]: ../../customization.md#additional-css
|
||||||
[Highlight.js]: https://highlightjs.org/
|
[Highlight.js]: https://highlightjs.org/
|
||||||
[title]: ../../reference/code-blocks.md#adding-a-title
|
[title]: ../../reference/code-blocks.md#adding-a-title
|
||||||
[anchor_linenums support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.1.0
|
[anchor_linenums support]: https://github.com/squidfunk/mkdocs-material/releases/tag/8.1.0
|
||||||
|
Loading…
Reference in New Issue
Block a user