Skip to content

Commit 57e1fd5

Browse files
committed
docs: update links, minor edits
1 parent 1b72836 commit 57e1fd5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
@readme/markdown
44
===
55

6-
A [Unified](https://github.com/unifiedjs)-based Markdown parser for ReadMe. ![CI Status](https://github.com/readmeio/markdown/workflows/CI/badge.svg)
6+
ReadMe's flavored Markdown parser and MDX rendering engine. ![CI Status](https://github.com/readmeio/markdown/workflows/CI/badge.svg)
77

88
```
99
npm install --save @readme/markdown
1010
```
1111

1212
## Usage
1313

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:
1515

1616
```jsx
1717
import React from 'react';
@@ -26,11 +26,11 @@ export default ({ body }) => (
2626

2727
### Export Methods
2828

29-
In addition to the default processor, the package exports some other methods for transforming ReadMe-flavored markdown:
29+
In addition to the default React processor, the package exports some other methods for transforming ReadMe-flavored markdown:
3030

3131
| Export | Description | Arguments |
3232
| -------:|:---------------------------------------------- |:--------------- |
33-
|*`react`*|(default) returns a VDOM tree object |`text`, `options`|
33+
|*`react`*|_(default)_ returns a VDOM tree object |`text`, `options`|
3434
|*`md`* | transform mdast in to ReadMe-flavored markdown |`tree`, `options`|
3535
|*`html`* | transform markdown in to HTML |`text`, `options`|
3636
|*`mdast`*| transform markdown to an mdast object |`text`, `options`|
@@ -42,13 +42,13 @@ In addition to the default processor, the package exports some other methods for
4242

4343
Each processor method takes an options object, which you can use to customize various outputs. Among them
4444

45-
- **`markdownOptions`**: [Remark parsing options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#processorusestringify-options)
4645
- **`correctnewlines`**: render new line delimeters as `<br>` tags.
46+
- **`markdownOptions`**: [Remark parsing options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#processorusestringify-options)
4747
- **`compatibilityMode`**: [enable compatibility features for ReadMe's old markdown engine](https://github.com/readmeio/api-explorer/issues/668).
4848

4949
## Flavored Syntax
5050

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)
5252

5353
## Credits
5454

0 commit comments

Comments
 (0)