Skip to content

Commit 56ac570

Browse files
committed
udpate comment for clarity
1 parent 7f7928a commit 56ac570

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/components/icon/index.tsx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
import React from "react";
22
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
33

4-
/* Note: Docusaurus/MDX v1 has parsing issues where some markdown renders statically and can cuse sibsequent links when beside a component or
5-
HTML tag while NOT in a section header or table, etc. https://github.com/mdx-js/mdx/issues/1571#issuecomment-853384939
4+
/* Note: Docusaurus/MDX v1 has parsing issues where some markdown renders statically when beside a component or HTML tag while NOT in a section header or table, etc. https://github.com/mdx-js/mdx/issues/1571#issuecomment-853384939
65
76
Exact issue here is noted here https://docusaurus.io/docs/markdown-features/react#markdown-and-jsx-interoperability.
87
98
This should be fixed when DS moves to MDX v2 https://github.com/facebook/docusaurus/issues/4029
109
11-
For now, we we wrap the anchor in this component for reusability. Other in-line workarounds are add a narrow no-break space (#8239; or &nnbsp;) before the <Icon /> or replace markdown syntax with equivalient html tags. */
10+
For now, we we wrap the anchor in this component for reusability. Other in-line workarounds are add a narrow no-break space (&#8239; or &nnbsp; or &nbsp; respectively) before the <Icon /> or replace markdown syntax with equivalent html tags. */
1211

1312
// TODO: refactor this component after DS moves to MDX v2.
1413

0 commit comments

Comments
 (0)