Skip to main content

mkdocs-ximages

mkdocs-ximages is a MkDocs plugin that turns Markdown images into semantic figures and adds a configurable image styling/rules layer.

![Mon bateau](./images/bateau.jpg)

becomes:

<figure class="ximage">
  <img src="./images/bateau.jpg" alt="Mon bateau">
  <figcaption>Mon bateau</figcaption>
</figure>

Exceptions are explicit:

![Inline image](icon.svg){.inline}
![Block image without caption](image.jpg){.nocaption}
![Completely untouched image](image.jpg){.no-ximages}

Layout and appearance can be combined:

![Mon bateau](boat.jpg){.left .clear .shadow .box width=40%}

The complete documentation is built from site/ and published to GitLab Pages.

Development

yarn install --immutable
yarn dev
yarn dev:lan
yarn build
yarn bfc
yarn smoke
yarn zip

The Python package is published on PyPI. Yarn/Vite are development tools used to compile SCSS and run the project workflow; mkdocs-ximages is not an npm runtime package.

Metadata

Release files for mkdocs-ximages 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-ximages 0.1.0
File Size Uploaded
mkdocs_ximages-0.1.0.tar.gz 25.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-ximages 0.1.0
File Interpreter ABI Platform
mkdocs_ximages-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 49.4 kB

Release files / mkdocs_ximages-0.1.0.tar.gz

Download URL mkdocs_ximages-0.1.0.tar.gz
Size 25.6 kB
Tags Source
SHA-256 checksum
How to use checksums
251bf467564b97b8ca800d3ab5cb270ff6e71e6047ffec3a0ba1f8f71a9590c3
BLAKE2b-256 checksum
How to use checksums
c28f5094296db00687ef3905c22df5f89c4fcdc028c09d0077f80de8bb66381b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / mkdocs_ximages-0.1.0-py3-none-any.whl

Download URL mkdocs_ximages-0.1.0-py3-none-any.whl
Size 23.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6098c383b3c4f8dae055a3f43149186c82f80378b0b44cb8da8139afe1cc042d
BLAKE2b-256 checksum
How to use checksums
0716b515e0c5261083bc29cc1ff68d6609eed9b768c3d3b15e4b2838dff05b10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page