@paperist/remark-caption
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    @paperist/remark-caption

    LICENSE NPM standard-readme compliant

    wooorm/remark plugin for caption

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

    Table of Contents

    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

    Install

    npm i @paperist/remark-caption

    DownloadsWeekly Downloads

    2

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    23 kB

    Total Files

    12

    Last publish

    Collaborators

    • 3846masa
    • paperist-owner