contentful
rich-text-from-markdown
A library to convert markdown to Contentful Rich Text document format.
Installation
Using npm:
npm install @contentful/rich-text-from-markdownUsing yarn:
yarn add @contentful/rich-text-from-markdownUsage
Basic
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');
const document = await richTextFromMarkdown('# Hello World');Advanced
The library will convert automatically the following markdown nodes:
paragraphheadingtextemphasisstrongdeleteinlineCodelinkthematicBreakblockquotelistlistItemtabletableRowtableCell
If the markdown content has unsupported nodes like 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:
const { richTextFromMarkdown } = require('@contentful/rich-text-from-markdown');
// define your own type for unsupported nodes like asset
const document = await richTextFromMarkdown(
"",
(node) => ({
nodeType: 'embedded-[entry|asset]-[block|inline]',
content: [],
data: {
target: {
sys: {
type: 'Link',
linkType: 'Entry|Asset',
id: '.........',
},
},
},
}),
);