Logo for jsDocs.io

react-markdown

  • Version 9.0.1
  • Published
  • 45.4 kB
  • 10 dependencies
  • MIT license

Install

npm i react-markdown
yarn add react-markdown
pnpm add react-markdown

Overview

React component to render markdown

Index

Functions

Type Aliases

Functions

function defaultUrlTransform

defaultUrlTransform: (value: string) => string;

  • Make a URL safe.

    {UrlTransform}

    Parameter value

    URL.

    Returns

    {string} Safe URL.

function Markdown

Markdown: (options: Readonly<Options>) => JSX.Element;

  • Component to render markdown.

    Parameter options

    Props.

    Returns

    {JSX.Element} React element.

Type Aliases

type AllowElement

type AllowElement = import('./lib/index.js').AllowElement;

    type Components

    type Components = import('./lib/index.js').Components;

      type ExtraProps

      type ExtraProps = import('hast-util-to-jsx-runtime').ExtraProps;

        type Options

        type Options = import('./lib/index.js').Options;

          type UrlTransform

          type UrlTransform = import('./lib/index.js').UrlTransform;

            Package Files (2)

            Dependencies (10)

            Dev Dependencies (17)

            Peer Dependencies (2)

            Badge

            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/react-markdown.

            • Markdown
              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/react-markdown)
            • HTML
              <a href="https://www.jsdocs.io/package/react-markdown"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>