Enhance your MkDocs documentation with easy figure, table captioning and numbering.
Project description
MkDocs Caption
Package | |
Meta | |
CI |
Enhance your MkDocs documentation with easy figure, table captioning and numbering.
Features
- Table and Figure captioning and numbering
- Automatic link text generation for references
- Highly configurable
- Extensible to support captions for all Element types
Documentation
For full documentation, visit https://tobiasah.github.io/mkdocs-caption/.
Installation
pip install mkdocs-caption
Quick Usage
In mkdocs.yml
:
...
plugins:
- caption
Inside the Markdown, the following will now be converted into a figure/table with caption and numbering.
![figure caption](img.jpg)
Table: table caption
| heading 1| heading 2 |
| - | - |
| content 1 | content 2 |
| content 3 | content 4 |
<p>
<figure id=_figure-1>
<img src="img.jpg" />
<figcaption>Figure 1. figure caption</figcaption>
</figure>
</p>
<p>
<table id="_table_1">
<thead>
<tr>
<th>heading 1</th>
<th>heading 2</th>
</tr>
</thead>
<tbody>
<tr>
<td>content 1</td>
<td>content 2</td>
</tr>
<tr>
<td>content 3</td>
<td>content 4</td>
</tr>
</tbody>
<caption>Table 1: table caption</caption>
</table>
License
mkdocs-caption
is distributed under the terms of the MIT license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs_caption-1.0.0.tar.gz
(188.4 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_caption-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 364d4a7bbb0684311b93bdadfa786586a19f5b88bae09985a5775082220e731b |
|
MD5 | 0eb315e7721bc22f4bb5f6b3b25b5dd7 |
|
BLAKE2b-256 | 2294abcdae18ddaed11a8c42b001f8af0ae3cde768d3753e798991197590d048 |