@paperist/remark-caption

wooorm/remark plugin for caption

Support Pandoc's table / code caption at wooorm/remark.

Table of Contents

• Install
• Usage
• AST
  • CaptionBlock
• Contribute
• License

Install

npm i remark @paperist/remark-caption

Usage

const unified = require('unified');
const parser = require('remark-parse');
const tableCaption = require('@paperist/remark-caption');

const markdown = `
| Right | Left | Default | Center |
|------:|:-----|---------|:------:|
|   12  |  12  |    12   |    12  |
|  123  |  123 |   123   |   123  |
|    1  |    1 |     1   |     1  |

Table: Demonstration of pipe table syntax.


~~~rb
puts "Hello World!";
~~~

Code: Hello World written by Ruby.
`;

const processor = unified()
  .use(parser)
  .use(tableCaption);
const ast = processor.parse(markdown);

processor.run(ast).then((ast) => {
  console.dir(ast, { depth: null });
});

AST

See also mdast, unist.

CaptionBlock

CaptionBlock extends Parent.

interface CaptionBlock extends Parent {
  type: 'captionBlock';
}

For example, the following markdown:

Table: Caption {#tbl:label}

Yields:

{
  "type": "captionBlock",
  "children": [
    {
      "type": "text",
      "value": "Caption {#tbl:lable}"
    }
  ]
}

Contribute

PRs accepted.

License

MIT (c) 3846masa