Add improved docs

Closes GH-657 Reviewed-by: Merlijn Vos <merlijn@soverin.net>
remarkjs · Nov 29, 2021 · 4185f06 · 4185f06
1 parent 8e07e9c
commit 4185f06
Show file tree

Hide file tree

Showing 3 changed files with 245 additions and 89 deletions.
diff --git a/lib/react-markdown.js b/lib/react-markdown.js
@@ -65,6 +65,8 @@ const deprecated = {
 }
 
 /**
+ * React component to render markdown.
+ *
  * @param {ReactMarkdownOptions} options
  * @returns {ReactElement}
  */

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-markdown",
   "version": "7.1.0",
-  "description": "Render Markdown as React components",
+  "description": "React component to render markdown",
   "license": "MIT",
   "keywords": [
     "remark",