@peaceroad/markdown-it-figure-with-p-caption 0.3.3 → 0.4.0

package/README.md

@@ -10,6 +10,8 @@ For a paragraph with only one image, a table or code block or a blockquote, and
 
 The figcaption behavior of this plugin depends on [p7d-markdown-it-p-captions](https://www.npmjs.com/package/p7d-markdown-it-p-captions).
 
+Note. If code block language setting is "samp", change it to use samp element instead of code element.
+
 Use it as follows.
 
 ```js
@@ -27,10 +29,10 @@ console.log(md.render('Figure. A Cat.\n\n![Figure](cat.jpg)');
 
 Also, It is recommended to set the width and height attributes of the images at the same time. See: [@peaceroad/markdown-it-renderer-image](https://www.npmjs.com/package/@peaceroad/markdown-it-renderer-image).
 
-It could be applied to table, codeblock(pre > code, pre > samp), video, audio as well.
+It could be applied to table, codeblock(pre > code, pre > samp), video as well.
 
-Example:
 
+## Example
 
 ~~~
 [Markdown]
@@ -157,6 +159,43 @@ A paragraph.
 </samp></pre>
 </figure>
 <p>A paragraph.</p>
+
+
+[Markdown]
+A paragraph.
+
+Video. A mp4.
+
+<video controls width="400" height="300">
+<source src="example.mp4" type="video/mp4">
+</video>
+
+A paragraph.
+[HTML]
+<p>A paragraph.</p>
+<figure class="f-video">
+<figcaption><span class="f-video-label">Video<span class="f-video-label-joint">.</span></span> A mp4.</figcaption>
+<video controls width="400" height="300">
+<source src="example.mp4" type="video/mp4">
+</video>
+</figure>
+<p>A paragraph.</p>
+
+[Markdown]
+A paragraph.
+
+Video. A youtube.
+
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/XXXXXXXXXXX" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+A paragraph.
+[HTML]
+<p>A paragraph.</p>
+<figure class="f-video">
+<figcaption><span class="f-video-label">Video<span class="f-video-label-joint">.</span></span> A youtube.</figcaption>
+<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/XXXXXXXXXXX" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+</figure>
+<p>A paragraph.</p>
 ~~~
 
 
@@ -222,3 +261,27 @@ A paragraph.
 </figure>
 <p>A paragraph.</p>
 ~~~
+
+## Option: Convert one image paragraph without caption
+
+Convert one image paragraph without a caption paragraph to figure element.
+
+```js
+md.use(mdFigureWithPCaption, {oneImageWithoutCaption: true});
+```
+
+~~~
+[Markdown]
+A paragraph.
+
+![Figure](cat.jpg)
+
+A paragraph.
+
+[HTML]
+<p>A paragraph.</p>
+<figure class="f-img">
+<img src="cat.jpg" alt="Figure">
+</figure>
+<p>A paragraph.</p>
+~~~

package/index.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const { has } = require('markdown-it/lib/common/utils');
-
 module.exports = function figure_with_caption_plugin(md, option) {
 
   const mdPCaption = require('p7d-markdown-it-p-captions');
@@ -11,6 +9,7 @@ module.exports = function figure_with_caption_plugin(md, option) {
     scaleSuffix: false,
     dquoteFilename: false,
     strongFilename: false,
+    oneImageWithoutCaption: false,
   };
   if (option !== undefined) {
     for (let o in option) {
@@ -251,7 +250,7 @@ module.exports = function figure_with_caption_plugin(md, option) {
         tagName = 'img';
         nextToken.children[0].type = 'image';
         caption = checkCaption(state, n, en, tagName, caption);
-        if (caption.hasPrev || caption.hasNext) {
+        if (opt.oneImageWithoutCaption || caption.hasPrev || caption.hasNext) {
           range = wrapWithFigure(state, range, tagName, true);
         }
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peaceroad/markdown-it-figure-with-p-caption",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "A markdown-it plugin. For a paragraph with only one image, a table or code block or blockquote, and by writing a caption paragraph immediately before or after, they are converted into the figure element with the figcaption element.",
   "main": "index.js",
   "scripts": {

package/test/examples.txt

@@ -266,7 +266,6 @@ A paragraph.
 <p><img src="cat.jpg" alt="Figure"></p>
 
 
-
 [Markdown]
 Figure. A cat.
 
@@ -489,3 +488,22 @@ A paragraph.
 </code></pre>
 </figure>
 <p>A paragraph.</p>
+
+[Markdown]
+![Figure](cat.jpg)
+
+A paragraph.
+
+![Figure](cat.jpg)
+
+A paragraph.
+
+[HTML]
+<figure class="f-img">
+<img src="cat.jpg" alt="Figure">
+</figure>
+<p>A paragraph.</p>
+<figure class="f-img">
+<img src="cat.jpg" alt="Figure">
+</figure>
+<p>A paragraph.</p>

package/test/test.js

@@ -5,11 +5,14 @@ const md = require('markdown-it')({
 });
 const mdFigureWithPCaption = require('../index.js');
 
+
 md.use(mdFigureWithPCaption, {
   dquoteFilename: true,
   strongFilename: true,
+  oneImageWithoutCaption: true,
 });
 
+
 const example = __dirname + '/examples.txt';
 const mdPath = __dirname + '/examples.md';
 const exampleCont = fs.readFileSync(example, 'utf-8').trim();