MkDocs Img2Fig v2 Plugin
this project fix bug and add new feature in MkDocs Img2Fig plugin
This MkDocs plugin converts markdown encoded images like
{align="right" width="20%"}
into
<figure class="figure-image">
<img src="../../images/my-image.png" alt="An image caption" align="left" width="20%" >
<figcaption>An image caption</figcaption>
</figure>
- of course, you could leave out
{align="right" width="20%"} - support attr : https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/img
center image
unfortunately, align:center is not supported. if you want to center image, add style="display:block; margin:0 auto;
for example
{width="20%" style="display:block; margin:0 auto;"}
Requirements
This package requires Python >=3.6 and MkDocs version 1.0 or higher.
Installation
Install the package with pip:
pip install mkdocs-img2figv2-plugin
Enable the plugin in your mkdocs.yml:
plugins:
- search
- img2figv2
Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation
Known issue
it won't work with setting use_directory_urls: false in your mkdocs.yml ( true is default )
Metadata
Release files for mkdocs-img2figv2-plugin 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs-img2figv2-plugin-0.0.2.tar.gz | 3.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_img2figv2_plugin-0.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.5 kB
Release files / mkdocs-img2figv2-plugin-0.0.2.tar.gz
| Download URL | mkdocs-img2figv2-plugin-0.0.2.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa9265739978f51191873fbb222de9d385f019fac3e86a997da6071abfa74a06
|
|
BLAKE2b-256 checksum How to use checksums |
ae7e2c15351d2268c6498211a200b10fb2400c0ef699a449054016462f165183
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.8.5
|
Release files / mkdocs_img2figv2_plugin-0.0.2-py3-none-any.whl
| Download URL | mkdocs_img2figv2_plugin-0.0.2-py3-none-any.whl |
|---|---|
| Size | 4.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c47a02207d84a07827886f11b168bdae2347b61c1e211d025fd884f58849bdcc
|
|
BLAKE2b-256 checksum How to use checksums |
76126b2a8b4d9de8e76e82040b027e6258307010620e970cfb419f56ae868bc0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.8.5
|