rich-text-from-markdown

A library to convert markdown to Contentful Rich Text document format.

Installation

Using npm:

``sh
npm install @contentful/rich-text-from-markdown
`

Using yarn:

`sh
yarn add @contentful/rich-text-from-markdown
`

Usage

$3

`js
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');

const document = await richTextFromMarkdown('# Hello World');
`

$3

The library will convert automatically the following markdown nodes:

- paragraph
- heading
- text
- emphasis
- strong
- delete
- inlineCode
- link
- thematicBreak
- blockquote
- list
- listItem
- table
- tableRow
- tableCell

If the markdown content has unsupported nodes like image !image you can add a callback as a second argument
and it will get called everytime an unsupported node is found. The return value of the callback will be the rich text representation
of that node.

#### Example:

`js
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');

// define your own type for unsupported nodes like asset
const document = await richTextFromMarkdown(
"!image",
(node) => ({
nodeType: 'embedded-[entry|asset]-[block|inline]',
content: [],
data: {
target: {
sys: {
type: 'Link',
linkType: 'Entry|Asset',
id: '.........',
},
},
},
}),
);
``