@dotconnor/grommet
Version:
focus on the essential experience
52 lines (39 loc) • 1.43 kB
Markdown
## GrommetMarkdown
Markdown formatting using Grommet components.
Grommet uses 'markdown-to-jsx' in Markdown component,
you can see all the options in the documentation.
[](https://storybook.grommet.io/?selectedKind=Type-Markdown&full=0&stories=1&panelRight=0) [](https://codesandbox.io/s/github/grommet/grommet-sandbox?initialpath=/markdown&module=%2Fsrc%2FMarkdown.js)
## Usage
```javascript
import { Markdown } from 'grommet';
<Markdown>{content}</Markdown>
```
## Properties
**components**
Custom components and props to override html elements such as 'img'
or 'pre'. By default 'a', 'p', 'img', and table elements are overridden
with grommet components.
Available options:
a: { component: Anchor },
img: { component: Image },
p: { component: Paragraph },
table: { component: Table },
td: { component: TableCell },
tbody: { component: TableBody },
tfoot: { component: TableFooter },
th: { component: TableCell },
thead: { component: TableHeader },
tr: { component: TableRow }
```
object
```
**options**
Used to tune the jsx compiler to specific properties, available options on [markdown-to-jsx](https://github.com/probablyup/markdown-to-jsx).
```
{
}
```
## Intrinsic element
```
div
```