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-0.0.11.tar.gz
(188.1 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_caption-0.0.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c954ec351a1f8ed15ef6f74b623614afb93ca6a6b15864e91f3f5389100e463a |
|
MD5 | cbc312847abf3e81b581b14d3e1a7709 |
|
BLAKE2b-256 | 1c15e83142d378307a4a4e8e9c0fd100ce7bb0054a5fa61ab12a73ae64e159d9 |