Skip to content

Commit 886ec83

Browse files
authored
Upgrade to react-markdown 9 (#1957)
1 parent 710568e commit 886ec83

File tree

4 files changed

+828
-313
lines changed

4 files changed

+828
-313
lines changed

packages/visx-demo/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@
8484
"react": "^18.2.0",
8585
"react-dom": "^18.2.0",
8686
"react-github-button": "^0.1.10",
87-
"react-markdown": "^4.3.1",
87+
"react-markdown": "^9.0.1",
88+
"rehype-raw": "^7.0.0",
8889
"topojson-client": "^3.0.0"
8990
},
9091
"publishConfig": {

packages/visx-demo/src/components/ApiTable.tsx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React, { useMemo } from 'react';
2-
import Markdown from 'react-markdown/with-html';
2+
import Markdown from 'react-markdown';
33
import type { DocGenInfo, PropInfo, ParamInfo } from '../types';
44
import { toExportName } from './util/format';
55
import { getGitHubUrl } from '../utils/getGitHubUrl';
@@ -58,7 +58,7 @@ export default function ApiTable({ docgenInfo }: Props) {
5858
</h3>
5959
{description && (
6060
<div className="doc-description">
61-
<Markdown source={description} />
61+
<Markdown>{description}</Markdown>
6262
</div>
6363
)}
6464
{isFunction && parameters && parameters.length > 0 ? (
@@ -82,13 +82,13 @@ export default function ApiTable({ docgenInfo }: Props) {
8282
)}
8383
</div>
8484
<div className="description">
85-
<Markdown
86-
source={`${param.description || ''}${
85+
<Markdown>
86+
{`${param.description || ''}${
8787
param.defaultValue
8888
? `\n\nDefault \`${String(param.defaultValue.value) || '""'}\``
8989
: ''
9090
}`}
91-
/>
91+
</Markdown>
9292
</div>
9393
</div>
9494
);
@@ -119,13 +119,13 @@ export default function ApiTable({ docgenInfo }: Props) {
119119
{prop.required && <span className="kind-badge required">required</span>}
120120
</div>
121121
<div className="description">
122-
<Markdown
123-
source={`${prop.description}${
122+
<Markdown>
123+
{`${prop.description}${
124124
prop.defaultValue
125125
? `\n\nDefault \`${String(prop.defaultValue.value) || '""'}\``
126126
: ''
127127
}`}
128-
/>
128+
</Markdown>
129129
</div>
130130
</div>
131131
);

packages/visx-demo/src/components/DocPage.tsx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
/* eslint-disable no-underscore-dangle */
22
import React from 'react';
3-
import Markdown from 'react-markdown/with-html';
3+
import Markdown from 'react-markdown';
4+
import rehypeRaw from 'rehype-raw';
45

56
import ApiTable from './ApiTable';
67
import PackageList from './PackageList';
@@ -24,7 +25,7 @@ export default function DocPage({ components, examples, visxPackage, readme }: P
2425
</div>
2526
<div className="doc-content">
2627
<div className="doc-readme">
27-
<Markdown escapeHtml={false} source={readme} />
28+
<Markdown rehypePlugins={[rehypeRaw]}>{readme}</Markdown>
2829
</div>
2930
{examples && examples.length > 0 && (
3031
<>

0 commit comments

Comments
 (0)