16.0.0 • Published 9 months ago

@contentful/rich-text-from-markdown v16.0.0

Weekly downloads
5,355
License
MIT
Repository
github
Last release
9 months ago

rich-text-from-markdown

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

Installation

Using npm:

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

Using yarn:

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

Usage

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:

  • 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](url) 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(
  "![image]('https://example.com/image.jpg')",
  (node) => ({
    nodeType: 'embedded-[entry|asset]-[block|inline]',
    content: [],
    data: {
      target: {
        sys: {
          type: 'Link',
          linkType: 'Entry|Asset',
          id: '.........',
        },
      },
    },
  }),
);
16.0.0

9 months ago

15.18.10

11 months ago

15.17.4

1 year ago

15.17.5

1 year ago

15.17.2

1 year ago

15.17.3

1 year ago

15.17.0

1 year ago

15.17.1

1 year ago

15.18.9

11 months ago

15.18.7

1 year ago

15.18.8

12 months ago

15.18.5

1 year ago

15.18.6

1 year ago

15.18.3

1 year ago

15.18.4

1 year ago

15.18.1

1 year ago

15.18.2

1 year ago

15.18.0

1 year ago

15.16.15

1 year ago

15.16.14

1 year ago

15.16.13

1 year ago

15.16.12

2 years ago

15.16.11

2 years ago

15.16.10

2 years ago

15.16.9

2 years ago

15.16.7

2 years ago

15.16.8

2 years ago

15.16.5

2 years ago

15.16.6

2 years ago

15.16.4

2 years ago

15.16.3

2 years ago

15.16.2

3 years ago

15.16.0

3 years ago

15.15.1

3 years ago

15.13.0

3 years ago

15.13.1

3 years ago

15.12.1

3 years ago

15.12.0

3 years ago

15.9.0

4 years ago

15.9.1

4 years ago

15.11.2

3 years ago

15.11.0

4 years ago

15.10.1

4 years ago

15.11.1

4 years ago

15.10.0

4 years ago

15.6.0

4 years ago

15.6.2

4 years ago

15.5.1

4 years ago

15.3.6

4 years ago

15.3.5

4 years ago

15.3.2

4 years ago

15.3.1

4 years ago

15.3.3

4 years ago

15.3.0

4 years ago

15.1.0

4 years ago

15.0.0

4 years ago

14.1.2

5 years ago

14.1.1

5 years ago

14.1.0

5 years ago

13.4.0

6 years ago

13.1.0

6 years ago

13.0.1

6 years ago

13.0.0

7 years ago

12.2.0

7 years ago

12.1.2

7 years ago

12.1.1

7 years ago

12.1.0

7 years ago

12.0.1

7 years ago

12.0.0

7 years ago

11.0.0

7 years ago

10.3.0

7 years ago

10.2.0

7 years ago

10.1.0

7 years ago

10.0.4

7 years ago

10.0.3

7 years ago

10.0.2

7 years ago

10.0.1

7 years ago