You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
@readme/markdown
4
4
===
5
5
6
-
A [Unified](https://github.com/unifiedjs)-based Markdown parser for ReadMe. 
6
+
ReadMe's flavored Markdown parser and MDX rendering engine. 
7
7
8
8
```
9
9
npm install --save @readme/markdown
10
10
```
11
11
12
12
## Usage
13
13
14
-
By default, the updated markdown package exports a function which takes a string of [ReadMe-flavored markdown](#readme-flavored-syntax) and returns a tree of React components:
14
+
By default, the updated markdown package exports a function which takes a string of [ReadMe-flavored markdown](https://rdmd.readme.io/) and returns a tree of React components:
-**`compatibilityMode`**: [enable compatibility features for ReadMe's old markdown engine](https://github.com/readmeio/api-explorer/issues/668).
48
48
49
49
## Flavored Syntax
50
50
51
-
Our old editor compiled custom "Magic Block" components from a JSON-based syntax. To provide seamless backwards-compatibility, the updated Markdown processor ships with built in support for parsing this old format and transpiling it in to standard, GitHub-flavored markdown. We've also sprinkled a bit of our own syntactic sugar on top, which let's you supercharge your docs. [**Read more about ReadMe's flavored syntax!**](https://rdmd.readme.io)
51
+
Our old editor compiled custom "Magic Block" components from a JSON-based syntax. To provide seamless backwards-compatibility, the updated Markdown processor ships with built in support for parsing this old format and transpiling it in to standard, GitHub-flavored markdown. We've also sprinkled a bit of our own syntactic sugar on top, which let's you supercharge your docs. [**Read more about ReadMe's flavored syntax!**](https://docs.readme.com/rdmd/docs/syntax-extensions)
0 commit comments