docsify-image-caption is a simple plugin to show the title/caption of image. Using it, the caption of image will be shown under the image.
In addtion to caption, docsify-image-caption will automatically convert the image into a block element based on the position of the image.
The usage and the corresponding effects are as follow.
This is an inline image, ![](docsify.png 'logo'), with the title "logo".
This is an inline image, , with the title "logo".
This is an inline image, ![](docsify.png), without title.
This is an inline image, , without title.
This is a block image.
![](docsify.png 'logo')
It has a title named logo.
This is a block image.
It has a title named logo.
This is a block image .
![](docsify.png)
It has no title.
This is a block image .
It has no title.
If you want add title to an image, but not display the caption, please use the following HTML label.
<img src='docsify.png' title='title' data-no-caption>
If you want add title to an image, but not display the caption, please use the following HTML label.
<!DOCTYPE html>
<head>
<!-- ... -->
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
// ...
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="https://unpkg.com/@h-hg/docsify-image-caption/dist/docsify-image-caption.min.js"></script>
<!-- or -->
<!-- <script src="https://cdn.jsdelivr.net/gh/h-hg/docsify-image-caption/dist/docsify-image-caption.min.js"></script> -->
</body>
</html>
Create a GitHub issue for bug reports, feature requests, or questions Add a star star on GitHub to support the plugin!
This project is licensed under the terms of the MIT license.