mkdocs-caption 0.0.8

No project description provided

MkDocs Caption

Package
Meta

---

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

---

Table of Contents

• Installation
• Quick Usage
• Images
• Tables
• Custom captions
• Configuration
• License

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>

Images

The plugin uses the title attribute as the source for the caption. The fallback is the alt attribute. If neither is present the image will not be captioned. The caption is prefixed with the image number. The image number is incremented for every image that is captioned.

Markdown this offers three ways to add a caption to an image.

![figure caption](img.jpg)

![](img.jpg "figure caption")

![](img.jpg){title="figure caption"}

Each captioned image is also assosiated with an id, which by default is constructed from the image number (_figure-x). It is also possible to overwrite the default id by adding an attribute id to an image. The id can be used to link to the image. The plugin also adds a link text (figure x) to all references without a link text. Please note that this feature does not support cross page references.

take a look at [](#_figure-1).

take a look at <a href="#_figure-1">figure 1</a>.

Customizing The Figure Element

MKDocs allows customizing the image element by adding attributes to the image tag. This is done by adding a curly bracket after the image tag and specifying the attributes inside the curly brackets. To apply the same kind of customization to the figure element the plugin allows adding attributes to the figure element. To maintain compatibility with the general Markdown syntax, one needs to use a separate line for the figure caption.

Figure: figure caption {class="my-class"}

![](img.jpg)

This will result in

<figure id="_figure-1" class="my-class">
  <img src="img.jpg" />
  <figcaption>Figure 1. figure caption</figcaption>

Tables

The plugin allows easy captioning of tables in markdown. Since Markdown does not support captions for tables the plugin uses a custom syntax here. A predefined prefix is used to identify a table caption (Table:). The caption must be placed right before the table (even if the caption should be at the bottom of the table). The caption is prefixed with the table number. The table number is incremented for every image that is captioned.

Table: table caption

| heading 1| heading 2 |
| - | - |
| content 1 | content 2 |
...

Each captioned table is also associated with an id, which by default is constructed from the table number (_table-x). It is also possible to overwrite the default id by adding an attribute id to the table (see below). The id can be used to link to the table. The plugin also adds a link text (table x) to all references without a link text. Please note that this feature does not support cross page references.

take a look at [](#_table-1).

take a look at <a href="#_table-1">table 1</a>.

The caption can also be extended by attributes that are automatically added to the table element. The attributes are specified similar to image attributes to be curly brackets. There are two attributes that have special meaning: id and cols. The id attribute is used to overwrite the default id of the table. The cols attribute can be used to control the column width of the table.

Table: table caption {id="my-table" cols="1,3"}

| heading 1| heading 2 |
| - | - |
| content 1 | content 2 |
...

Table 1: table caption

heading 1	heading 2
content 1	content 2
content 3	content 4

Note that the sum of the specified column widths is treated as 100%.

Custom captions

In addition to tables and figures, the plugin also supports custom captions. Custom captions must be manually defined in the mkdocs.yml file. Similar to table captions, they are placed right before the target element (e.g. an enumeration). The plugin will wrap the target element in a figure with the specified caption and options.

In mkdocs.yml:

...
plugins:
- caption:
    additional_identifier: [`List`]

In Markdown:

List: list caption

1. item 1
2. item 2

<figure id="_list-1">
  <ul>
    <li>item 1</li>
    <li>item 2</li>
  </ul>
  <figcaption>List 1: list caption</figcaption
</figure>

The same configuration options as for the table also apply for the custom captions. Note that each identifier has its own counter.

Configuration

The plugin can be configured in the mkdocs.yml file. The following options are available:

plugins:
  - caption:
    additional_identifier: [] # list of additional identifiers (e.g. [`List`, `Example`])
    table:
      enable: true
      start_index: 1
      increment_index: 1
      position: bottom  # (top, bottom)
      default_id: '_table-{index}'
      reference_text: 'Table {index}'
      caption_prefix: 'Table {index}:'
      markdown_identifier: 'Table:'
    figure:
      enable: true
      start_index: 1
      increment_index: 1
      position: bottom
      default_id: '_figure-{index}'
      reference_text: 'Figure {index}'
      caption_prefix: 'Figure {index}:'
      markdown_identifier: 'Figure:'
    custom:
      enable: true
      start_index: 1
      increment_index: 1
      position: bottom
      default_id: '_{identifier}-{index}'
      reference_text: '{Identifier} {index}'
      caption_prefix: '{Identifier} {index}:'
      markdown_identifier: '{Identifier}:'

The {index} placeholders are replaced with the current index. The {identifier} placeholder is replaced with the lower case identifier and the {Identifier} is replaced with the capitalized identifier.

Option	Description
enable	Enable/disable the captioning/plugin for the specified identifier
start_index	The index to start with
increment_index	The increment for the index
position	The position of the caption (top, bottom) relative to the target element
default_id	The default id assigned to the resulting HTML element
reference_text	The text used for references to this element. Note, this only will be applied if the anchor does not specify its own link text
caption_prefix	The prefix put before of the caption text
markdown_identifier	The identifier that this plugin will search for in the markdown. (Note that every match of this identifier will be treated as a caption element. A false match will most likely result in an error)

It is also possible to overwrite the default configuration for a specific page. This can be done by adding a caption section to the page header.

---
caption:
  table:
    start_index: 4
---
# Page Title
...

License

mkdocs-caption is distributed under the terms of the MIT license.