docs(v2): Add READMEs to v2 packages (#4034)

* docs(v2): Add READMEs to v2 packages Signed-off-by: Reece Dunham <me@rdil.rocks> * Update packages/docusaurus-remark-plugin-npm2yarn/package.json * Update packages/docusaurus/README.md * Update packages/docusaurus-plugin-sitemap/README.md Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
facebook · Jan 14, 2021 · 0252d01 · 0252d01
1 parent c94b445
commit 0252d01
Show file tree

Hide file tree

Showing 52 changed files with 154 additions and 38 deletions.
diff --git a/packages/docusaurus-cssnano-preset/README.md b/packages/docusaurus-cssnano-preset/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/cssnano-preset`
+
+An advanced cssnano preset for maximum optimization.
diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/cssnano-preset",
   "version": "2.0.0-alpha.70",
-  "description": "Advanced cssnano preset for maximum optimization",
+  "description": "Advanced cssnano preset for maximum optimization.",
   "main": "index.js",
   "license": "MIT",
   "publishConfig": {

diff --git a/packages/docusaurus-init/README.md b/packages/docusaurus-init/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/init`
+
+Create Docusaurus apps easily.
+
+## Usage
+
+Please see the [installation documentation](https://v2.docusaurus.io/docs/installation).
diff --git a/packages/docusaurus-init/package.json b/packages/docusaurus-init/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/init",
   "version": "2.0.0-alpha.70",
-  "description": "Create Docusaurus app easily",
+  "description": "Create Docusaurus apps easily.",
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/docusaurus.git",

diff --git a/packages/docusaurus-mdx-loader/README.md b/packages/docusaurus-mdx-loader/README.md
@@ -1,6 +1,6 @@
 # `@docusaurus/mdx-loader`
 
-Docusaurus webpack loader of [MDX](https://github.com/mdx-js/mdx)
+Docusaurus webpack loader for [MDX](https://github.com/mdx-js/mdx).
 
 ## Installation
 

diff --git a/packages/docusaurus-migrate/README.md b/packages/docusaurus-migrate/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/migrate`
+
+A CLI tool to migrate from older versions of Docusuarus.
+
+## Usage
+
+Please see [the migration documentation](https://v2.docusaurus.io/docs/migration) for more information.
diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/migrate",
   "version": "2.0.0-alpha.70",
-  "description": "A cli tool to migrate between different version of Docusuarus",
+  "description": "A CLI tool to migrate from older versions of Docusuarus.",
   "main": "lib/index.js",
   "license": "MIT",
   "engines": {

diff --git a/packages/docusaurus-module-type-aliases/README.md b/packages/docusaurus-module-type-aliases/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/module-type-aliases`
+
+Docusaurus module type aliases.
diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/module-type-aliases",
   "version": "2.0.0-alpha.70",
-  "description": "Docusaurus module type aliases",
+  "description": "Docusaurus module type aliases.",
   "types": "./src/index.d.ts",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-plugin-client-redirects/README.md b/packages/docusaurus-plugin-client-redirects/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-client-redirects`
+
+Client redirects plugin for Docusaurus.
+
+## Usage
+
+See [plugin-client-redirects documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects).
diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-client-redirects",
   "version": "2.0.0-alpha.70",
-  "description": "Client redirects plugin for Docusaurus",
+  "description": "Client redirects plugin for Docusaurus.",
   "main": "lib/index.js",
   "scripts": {
     "build": "tsc",

diff --git a/packages/docusaurus-plugin-content-blog/README.md b/packages/docusaurus-plugin-content-blog/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-content-blog`
+
+Blog plugin for Docusaurus.
+
+## Usage
+
+See [plugin-content-blog documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-content-blog",
   "version": "2.0.0-alpha.70",
-  "description": "Blog plugin for Docusaurus",
+  "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "index.d.ts",
   "scripts": {

diff --git a/packages/docusaurus-plugin-content-docs/README.md b/packages/docusaurus-plugin-content-docs/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-content-docs`
+
+Docs plugin for Docusaurus.
+
+## Usage
+
+See [plugin-content-docs documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs).
diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-content-docs",
   "version": "2.0.0-alpha.70",
-  "description": "Docs content plugin for Docusaurus",
+  "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
   "scripts": {

diff --git a/packages/docusaurus-plugin-content-pages/README.md b/packages/docusaurus-plugin-content-pages/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-content-pages`
+
+Pages plugin for Docusaurus.
+
+## Usage
+
+See [plugin-content-pages documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages).
diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-content-pages",
   "version": "2.0.0-alpha.70",
-  "description": "Pages content plugin for Docusaurus",
+  "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
   "scripts": {

diff --git a/packages/docusaurus-plugin-debug/README.md b/packages/docusaurus-plugin-debug/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-debug`
+
+Debug plugin for Docusaurus.
+
+## Usage
+
+See [plugin-debug documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug).
diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-debug",
   "version": "2.0.0-alpha.70",
-  "description": "Debug plugin for Docusaurus",
+  "description": "Debug plugin for Docusaurus.",
   "main": "lib/index.js",
   "scripts": {
     "build": "tsc",

diff --git a/packages/docusaurus-plugin-google-analytics/README.md b/packages/docusaurus-plugin-google-analytics/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-google-analytics`
+
+Google analytics plugin for Docusaurus.
+
+## Usage
+
+See [plugin-google-analytics documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-analytics).
diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-google-analytics",
   "version": "2.0.0-alpha.70",
-  "description": "Global analytics (analytics.js) plugin for Docusaurus",
+  "description": "Global analytics (analytics.js) plugin for Docusaurus.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-plugin-google-gtag/README.md b/packages/docusaurus-plugin-google-gtag/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-google-gtag`
+
+Global Site Tag (gtag.js) plugin for Docusaurus.
+
+## Usage
+
+See [plugin-google-gtag documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-google-gtag).
diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-google-gtag",
   "version": "2.0.0-alpha.70",
-  "description": "Global Site Tag (gtag.js) plugin for Docusaurus",
+  "description": "Global Site Tag (gtag.js) plugin for Docusaurus.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-plugin-ideal-image/README.md b/packages/docusaurus-plugin-ideal-image/README.md
@@ -1,6 +1,6 @@
 # `@docusaurus/plugin-ideal-image`
 
-Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)
+Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).
 
 ## Installation
 

diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-ideal-image",
   "version": "2.0.0-alpha.70",
-  "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)",
+  "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
   "main": "lib/index.js",
   "scripts": {
     "build": "tsc && node copyUntypedFiles.js",

diff --git a/packages/docusaurus-plugin-pwa/README.md b/packages/docusaurus-plugin-pwa/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-pwa`
+
+Progressive web app plugin for Docusaurus.
+
+## Usage
+
+See [plugin-pwa documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-pwa).
diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-pwa",
   "version": "2.0.0-alpha.70",
-  "description": "Docusaurus Plugin to add PWA support",
+  "description": "Docusaurus Plugin to add PWA support.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-plugin-sitemap/README.md b/packages/docusaurus-plugin-sitemap/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/plugin-sitemap`
+
+Simple sitemap generation plugin for Docusaurus.
+
+## Usage
+
+See [plugin-sitemap documentation](https://v2.docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap).
diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/plugin-sitemap",
   "version": "2.0.0-alpha.70",
-  "description": "Simple sitemap generation plugin for Docusaurus",
+  "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "scripts": {
     "build": "tsc",

diff --git a/packages/docusaurus-preset-bootstrap/README.md b/packages/docusaurus-preset-bootstrap/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/preset-bootstrap`
+
+Bootstrap preset for Docusaurus.
+
+## Usage
+
+See [presets documentation](https://v2.docusaurus.io/docs/presets).
diff --git a/packages/docusaurus-preset-bootstrap/package.json b/packages/docusaurus-preset-bootstrap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/preset-bootstrap",
   "version": "2.0.0-alpha.70",
-  "description": "Preset for bootstrap Docusaurus",
+  "description": "Bootstrap preset for Docusaurus.",
   "main": "src/index.js",
   "license": "MIT",
   "publishConfig": {

diff --git a/packages/docusaurus-preset-classic/README.md b/packages/docusaurus-preset-classic/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/preset-classic`
+
+Classic preset for Docusaurus.
+
+## Usage
+
+See [presets documentation](https://v2.docusaurus.io/docs/presets).
diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/preset-classic",
   "version": "2.0.0-alpha.70",
-  "description": "Preset for classic Docusaurus",
+  "description": "Classic preset for Docusaurus.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/remark-plugin-npm2yarn",
   "version": "2.0.0-alpha.70",
-  "description": "Remark plugin for convert npm commands to yarn as tabs",
+  "description": "Remark plugin for converting npm commands to Yarn commands as tabs.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-theme-bootstrap/package.json b/packages/docusaurus-theme-bootstrap/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/theme-bootstrap",
   "version": "2.0.0-alpha.70",
-  "description": "Bootstrap theme for docusaurus",
+  "description": "Bootstrap theme for Docusaurus.",
   "main": "src/index.js",
   "types": "src/types.d.ts",
   "license": "MIT",

diff --git a/packages/docusaurus-theme-common/README.md b/packages/docusaurus-theme-common/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/theme-common`
+
+Common code for Docusaurus themes.
diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/theme-common",
   "version": "2.0.0-alpha.70",
-  "description": "Common code for Docusaurus themes",
+  "description": "Common code for Docusaurus themes.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {

diff --git a/packages/docusaurus-theme-live-codeblock/README.md b/packages/docusaurus-theme-live-codeblock/README.md
@@ -1,4 +1,4 @@
-## Docusaurus Live Codeblock
+# Docusaurus Live Codeblock
 
 You can create live code editors with a code block `live` meta string.
 

diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/theme-live-codeblock",
   "version": "2.0.0-alpha.70",
-  "description": "Docusaurus Live CodeBlock",
+  "description": "Docusaurus live code block component.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-theme-search-algolia/README.md b/packages/docusaurus-theme-search-algolia/README.md
@@ -0,0 +1,7 @@
+# `@docusaurus/theme-search-algolia`
+
+Algolia search component for Docusaurus.
+
+## Usage
+
+See [`@docusaurus/theme-search-algolia` documentation](https://v2.docusaurus.io/docs/api/themes/@docusaurus/theme-search-algolia).
diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/theme-search-algolia",
   "version": "2.0.0-alpha.70",
-  "description": "Algolia search component for Docusaurus",
+  "description": "Algolia search component for Docusaurus.",
   "main": "src/index.js",
   "publishConfig": {
     "access": "public"

diff --git a/packages/docusaurus-types/README.md b/packages/docusaurus-types/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/types`
+
+Common types for Docusaurus packages.
diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/types",
   "version": "2.0.0-alpha.70",
-  "description": "Common used typings for Docusaurus packages",
+  "description": "Common types for Docusaurus packages.",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "publishConfig": {

diff --git a/packages/docusaurus-utils-validation/README.md b/packages/docusaurus-utils-validation/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/utils-validation`
+
+Node validation utility functions for Docusaurus packages.
diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/utils-validation",
   "version": "2.0.0-alpha.70",
-  "description": "Node validation utility functions for Docusaurus packages",
+  "description": "Node validation utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {

diff --git a/packages/docusaurus-utils/README.md b/packages/docusaurus-utils/README.md
@@ -0,0 +1,3 @@
+# `@docusaurus/utils`
+
+Node validation utility functions for Docusaurus packages.
diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/utils",
   "version": "2.0.0-alpha.70",
-  "description": "Node utility functions for Docusaurus packages",
+  "description": "Node utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "scripts": {

diff --git a/packages/docusaurus/README.md b/packages/docusaurus/README.md
@@ -1 +1 @@
-# Docusaurus v2
+