Metadata-Version: 2.4
Name: mkdocs-ximages
Version: 0.1.0
Summary: Extended image figures, captions, layout, styling and rules for MkDocs
Author-email: "Rod2ik, aka Rodrigo Schwencke" <rod2ik.dev@gmail.com>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://rod2ik.gitlab.io/mkdocs-ximages/
Project-URL: Documentation, https://rod2ik.gitlab.io/mkdocs-ximages/
Project-URL: Repository, https://gitlab.com/rod2ik/mkdocs-ximages
Project-URL: Issues, https://gitlab.com/rod2ik/mkdocs-ximages/-/issues
Keywords: mkdocs,markdown,images,figure,figcaption,captions,css,scss,documentation,material,education
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: MkDocs
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs<2.0,>=1.6
Requires-Dist: beautifulsoup4<5,>=4.12
Requires-Dist: PyYAML>=6.0
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: mkdocs-material<10,>=9; extra == "dev"
Requires-Dist: pymdown-extensions<11,>=10; extra == "dev"
Requires-Dist: pytest<10,>=8; extra == "dev"
Requires-Dist: twine>=6; extra == "dev"
Dynamic: license-file

# mkdocs-ximages

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

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

becomes:

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

Exceptions are explicit:

```markdown
![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:

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

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

## Development

```bash
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.
