@kun.js/react-md

react markdown parse and Component

latest

Source

npm

Version: 0.0.1-alpha.1

Version published: 6 years ago

Maintainers: 1

Created: 6 years ago

Source

@kun.js/react-md

A react markdown component, support customize all component！

install

npm i -S @kun.js/react-md
// or
yarn add @kun.js/react-md

usage

import { Markdown } from "@kun.js/react-md";

export () => <Markdown
  content={`# hello`}
/>

props

param	desc	type	default
content	md content	string
disableCatalogs	disable Catalogs	boolean	false
h	# Components	React.ComponentType[] ex: ['h1', ..., 'h6']
code	`Code` Component	React.ComponentType props: {value, lang}
inlineCode	`InlineCode` Component	React.ComponentType props: {value}
strong	Strong Component	React.ComponentType
emphasis	Emphasis Component	React.ComponentType
blockquote	> Blockquote Component	React.ComponentType
delete	~~Delete~~ Component	React.ComponentType
image	![Image]() Component	React.ComponentType props: {url: string; alt: string}
link	Link Component	React.ComponentType
lists	Lists Components	{ order: React.ComponentType, unorder: React.ComponentType}
listItem	- ListItem Component	React.ComponentType
table	Table Component	React.ComponentType props: {align: (null\| left\| center \| right)[]}
tableRow	TableRow Component	React.ComponentType
tableCells	TableCells Components	{ th: React.ComponentType, td: React.ComponentType} props: {align}
paragraph	Paragraph Component	React.ComponentType
html	<Html> Wrap Component	React.ComponentType

FAQs

What is @kun.js/react-md?

Is @kun.js/react-md well maintained?

Package last updated on 04 Sep 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install