starred/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2026-05-30 12:02:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source 
* Updated images documentation to include pymdownx.blocks.caption extension

* put back HTML figure in image caption docs

* fix typo in image captions
This commit is contained in:
Joan Puigcerver
2024-10-30 15:23:28 +01:00
committed by GitHub
parent 4918a10d8f
commit f82a345f3a
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -110,6 +110,25 @@ documentation][BetterEm] for more information.
[BetterEm]: https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
### Caption
<!-- md:version 1.0.0 -->
<!-- md:extension [pymdownx.blocks.caption][Caption] -->
The [Caption] extension adds the ability to add captions to any Markdown block,
including images, tables, and code blocks. Enable it via `mkdocs.yml`:
``` yaml
markdown_extensions:
- pymdownx.blocks.caption
```
The configuration options of this extension are not specific to Material for
MkDocs, as they only impact the Markdown parsing stage. See the [Caption
documentation][Caption] for more information.
[Caption]: https://facelessuser.github.io/pymdown-extensions/extensions/blocks/plugins/caption/
### Caret, Mark & Tilde
<!-- md:version 1.0.0 -->