rehype-title-figure

Rehype plugin that adds a caption using the title attribute of the img.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rehype-title-figure
0.1.22 years ago3 years agoMinified + gzip package size for rehype-title-figure in KB

Readme

rehype-title-figure
main codecov npm version Conventional Commits code style: prettier
Rehype plugin that adds a caption using the title attribute of the img.

Install

$ yarn add rehype-title-figure

or
$ npm i rehype-title-figure

Usage

import unified from 'unified'
import remark from 'remark-parse'
import remark2rehype from 'remark-rehype'
import stringify from 'rehype-stringify'

import rehypeTitleFigure from 'rehype-title-figure'

function compile(md: string) {
  return unified()
    .use(remark)
    .use(remark2rehype)
    .use(rehypeTitleFigure)
    .use(stringify)
    .processSync(md)
    .toString()
}

const output = compile(
  '![alt text](https://placehold.jp/150x150.png "caption text")'
)
console.log(output)

output:
<figure><img src="https://placehold.jp/150x150.png" alt="alt text" title="caption text"><figcaption>caption text</figcaption></figure>

LICENSE

MIT © y-temp4