rehype-image-caption

rehype plugin to set captions for images in addition to alt text.

Installation

``sh
npm install rehype-image-caption
`

Example

`javascript
import remarkParse from "remark-parse";
import rehypeStringify from "rehype-stringify";
import remarkRehype from "remark-rehype";
import { unified } from "unified";
import rehypeImageCaption from "rehype-image-caption";

const processor = unified()
.use(remarkParse)
.use(remarkRehype)
.use(rehypeImageCaption)
.use(rehypeStringify);

const markdown =
!alt text

!alt textcaption text

!alt text
caption text
;

processor.process(markdown).then((result) => {
console.log(result.toString());
});
`

The above code will output the following:

`html






`

Options

$3

- Type: boolean
- Default: true

Wrap images without captions in a

tag. If set to false, images without captions will not be wrapped in a

tag.

Development

$3

`sh
npm run build
`

$3

`sh
npm run format
`

or

`sh
npm run format:check
`

$3

`sh
npm run lint
`

$3

`sh
npm run test
`

$3

This repository uses Changesets to manage versioning and releases. When creating a pull request, please run the Changesets CLI and commit the changeset file.

`bash
npx changeset
``