From ce9d1549445cda85998ad6380f7168ce26231ff9 Mon Sep 17 00:00:00 2001 From: Rafe Goldberg Date: Tue, 11 Aug 2020 17:27:32 -0700 Subject: [PATCH] docs(readme): formatting and copy edits --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 074feab59..b02d2da2b 100644 --- a/README.md +++ b/README.md @@ -38,17 +38,19 @@ In addition to the default React processor, the package exports some other metho |*`plain`*| transform markdown to plain text |`text`, `options`| |*`utils`*| contexts, defaults, helpers, etc. | N/A | -#### Settings & Options +### Settings & Options -Each processor method takes an options object, which you can use to customize various outputs. Among them +Each processor method takes an options object which you can use to adjust the output HTML or React tree. These options include: -- **`correctnewlines`**: render new line delimeters as `
` tags. -- **`markdownOptions`**: [Remark parsing options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#processorusestringify-options) -- **`compatibilityMode`**: [enable compatibility features for ReadMe's old markdown engine](https://github.com/readmeio/api-explorer/issues/668). +- **`correctnewlines`**—render new line delimeters as `
` tags. +- **`markdownOptions`**—Remark [parser options](https://github.com/remarkjs/remark/tree/main/packages/remark-stringify#processorusestringify-options). +- **`compatibilityMode`**—enable [compatibility features](https://github.com/readmeio/api-explorer/issues/668) from our old markdown engine. ## Flavored Syntax -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) +Our old editor rendered "Magic Block" components from a custom, JSON-based syntax. To provide seamless backwards-compatibility, our new processor ships with built in support for parsing this old format, and transpiles it straight in to our new, flavored Markdown. + +We've also sprinkled a bit of our own syntactic sugar on top of all of this, which let's you supercharge your docs. [**Learn more about ReadMe-flavored Markdown!**](https://docs.readme.com/rdmd/docs/syntax-extensions) ## Credits