refactor: use markdown dialects (gfm as default)

This commit is contained in:
Jesko Steinberg
2020-11-03 14:39:39 +01:00
parent d76b465975
commit a963b59b04
4 changed files with 31 additions and 18 deletions
+6 -5
View File
@@ -1,15 +1,16 @@
---
'@backstage/core': minor
'@backstage/core': patch
---
Adds the MarkdownContent component to render and display markdown input.
Adds the MarkdownContent component to render and display Markdown content with the default
[GFM](https://github.github.com/gfm/) (Github flavored Markdown) dialect.
```
<MarkdownContent content={markdown} />
<MarkdownContent content={markdownGithubFlavored} />
```
Render and display the github flavored markdown [GFM](https://github.github.com/gfm/) input:
To render the Markdown content with plain [CommonMark](https://commonmark.org/), set the dialect to `common-mark`
```
<MarkdownContent content={markdownGithubFlavored} enableGfm />
<MarkdownContent content={markdown} dialect='common-mark />
```