From 0252d01ebb846587418cf1713926bb4664313e78 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Thu, 14 Jan 2021 11:16:26 -0500 Subject: [PATCH] docs(v2): Add READMEs to v2 packages (#4034) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(v2): Add READMEs to v2 packages Signed-off-by: Reece Dunham * 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 --- packages/docusaurus-cssnano-preset/README.md | 3 +++ packages/docusaurus-cssnano-preset/package.json | 2 +- packages/docusaurus-init/README.md | 7 +++++++ packages/docusaurus-init/package.json | 2 +- packages/docusaurus-mdx-loader/README.md | 2 +- packages/docusaurus-migrate/README.md | 7 +++++++ packages/docusaurus-migrate/package.json | 2 +- packages/docusaurus-module-type-aliases/README.md | 3 +++ packages/docusaurus-module-type-aliases/package.json | 2 +- .../docusaurus-plugin-client-redirects/README.md | 7 +++++++ .../docusaurus-plugin-client-redirects/package.json | 2 +- packages/docusaurus-plugin-content-blog/README.md | 7 +++++++ packages/docusaurus-plugin-content-blog/package.json | 2 +- packages/docusaurus-plugin-content-docs/README.md | 7 +++++++ packages/docusaurus-plugin-content-docs/package.json | 2 +- packages/docusaurus-plugin-content-pages/README.md | 7 +++++++ .../docusaurus-plugin-content-pages/package.json | 2 +- packages/docusaurus-plugin-debug/README.md | 7 +++++++ packages/docusaurus-plugin-debug/package.json | 2 +- .../docusaurus-plugin-google-analytics/README.md | 7 +++++++ .../docusaurus-plugin-google-analytics/package.json | 2 +- packages/docusaurus-plugin-google-gtag/README.md | 7 +++++++ packages/docusaurus-plugin-google-gtag/package.json | 2 +- packages/docusaurus-plugin-ideal-image/README.md | 2 +- packages/docusaurus-plugin-ideal-image/package.json | 2 +- packages/docusaurus-plugin-pwa/README.md | 7 +++++++ packages/docusaurus-plugin-pwa/package.json | 2 +- packages/docusaurus-plugin-sitemap/README.md | 7 +++++++ packages/docusaurus-plugin-sitemap/package.json | 2 +- packages/docusaurus-preset-bootstrap/README.md | 7 +++++++ packages/docusaurus-preset-bootstrap/package.json | 2 +- packages/docusaurus-preset-classic/README.md | 7 +++++++ packages/docusaurus-preset-classic/package.json | 2 +- .../docusaurus-remark-plugin-npm2yarn/package.json | 2 +- packages/docusaurus-theme-bootstrap/package.json | 2 +- packages/docusaurus-theme-common/README.md | 3 +++ packages/docusaurus-theme-common/package.json | 2 +- packages/docusaurus-theme-live-codeblock/README.md | 2 +- .../docusaurus-theme-live-codeblock/package.json | 2 +- packages/docusaurus-theme-search-algolia/README.md | 7 +++++++ .../docusaurus-theme-search-algolia/package.json | 2 +- packages/docusaurus-types/README.md | 3 +++ packages/docusaurus-types/package.json | 2 +- packages/docusaurus-utils-validation/README.md | 3 +++ packages/docusaurus-utils-validation/package.json | 2 +- packages/docusaurus-utils/README.md | 3 +++ packages/docusaurus-utils/package.json | 2 +- packages/docusaurus/README.md | 2 +- packages/lqip-loader/README.md | 12 ++++++------ packages/lqip-loader/package.json | 2 +- packages/stylelint-copyright/README.md | 4 ++-- packages/stylelint-copyright/package.json | 2 +- 52 files changed, 154 insertions(+), 38 deletions(-) create mode 100644 packages/docusaurus-cssnano-preset/README.md create mode 100644 packages/docusaurus-init/README.md create mode 100644 packages/docusaurus-migrate/README.md create mode 100644 packages/docusaurus-module-type-aliases/README.md create mode 100644 packages/docusaurus-plugin-client-redirects/README.md create mode 100644 packages/docusaurus-plugin-content-blog/README.md create mode 100644 packages/docusaurus-plugin-content-docs/README.md create mode 100644 packages/docusaurus-plugin-content-pages/README.md create mode 100644 packages/docusaurus-plugin-debug/README.md create mode 100644 packages/docusaurus-plugin-google-analytics/README.md create mode 100644 packages/docusaurus-plugin-google-gtag/README.md create mode 100644 packages/docusaurus-plugin-pwa/README.md create mode 100644 packages/docusaurus-plugin-sitemap/README.md create mode 100644 packages/docusaurus-preset-bootstrap/README.md create mode 100644 packages/docusaurus-preset-classic/README.md create mode 100644 packages/docusaurus-theme-common/README.md create mode 100644 packages/docusaurus-theme-search-algolia/README.md create mode 100644 packages/docusaurus-types/README.md create mode 100644 packages/docusaurus-utils-validation/README.md create mode 100644 packages/docusaurus-utils/README.md diff --git a/packages/docusaurus-cssnano-preset/README.md b/packages/docusaurus-cssnano-preset/README.md new file mode 100644 index 000000000000..af2e2066f1fd --- /dev/null +++ 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 index fa0ab3e096bf..3ea9656e00a0 100644 --- 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 new file mode 100644 index 000000000000..80af68c27438 --- /dev/null +++ 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 index ef995cf5e4bc..566c419ff8e4 100644 --- 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 index 704468540e2f..92a22ca6d817 100644 --- 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 new file mode 100644 index 000000000000..b58a55d9d9ac --- /dev/null +++ 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 index 44f5589b2fb1..8e7cb8e91dfd 100644 --- 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 new file mode 100644 index 000000000000..475af58172fa --- /dev/null +++ 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 index 6e6083836808..bb7fd8da4932 100644 --- 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 new file mode 100644 index 000000000000..53441a82cb29 --- /dev/null +++ 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 index ef905f48460c..55206b7cf97c 100644 --- 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 new file mode 100644 index 000000000000..03549d7dcc9c --- /dev/null +++ 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 index cd8de30880a9..de8699783099 100644 --- 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 new file mode 100644 index 000000000000..d15c22dccfff --- /dev/null +++ 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 index 2a1adaad8e49..b639dd705d63 100644 --- 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 new file mode 100644 index 000000000000..d33de6a52b5b --- /dev/null +++ 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 index 52ab201df379..a81293485c46 100644 --- 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 new file mode 100644 index 000000000000..8d0ae1e27475 --- /dev/null +++ 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 index 993a84234bd9..21d8907900f1 100644 --- 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 new file mode 100644 index 000000000000..e14f672cd8eb --- /dev/null +++ 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 index 94bc30698c04..a1484beb9045 100644 --- 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 new file mode 100644 index 000000000000..09660f222188 --- /dev/null +++ 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 index 66e83f1759b8..7b17f86c4046 100644 --- 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 index 2601947f943f..fdf47ddaf5c3 100644 --- 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 index 816e84211178..41fbb593f03e 100644 --- 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 new file mode 100644 index 000000000000..497375142352 --- /dev/null +++ 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 index a0e023d98538..d3067dff1ba6 100644 --- 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 new file mode 100644 index 000000000000..ffd011d42e97 --- /dev/null +++ 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 index 489cc788390f..65b11c98e1c6 100644 --- 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 new file mode 100644 index 000000000000..ff6169e63593 --- /dev/null +++ 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 index 02d1d81c1070..5bcddbbd56da 100644 --- 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 new file mode 100644 index 000000000000..69cdd2ae8255 --- /dev/null +++ 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 index 7d831a152688..e057799e3dfe 100644 --- 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 index 6e2394f9051e..e9007e3ba29c 100644 --- 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 index 28fdfbf11b57..a8f6b780fe36 100644 --- 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 new file mode 100644 index 000000000000..128124e513e0 --- /dev/null +++ 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 index 1f5715dd22da..9250f6799420 100644 --- 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 index be260f599263..1f31661ec9fd 100644 --- 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 index a629f44b8fb3..ca13cf51323f 100644 --- 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 new file mode 100644 index 000000000000..75a78c4e62e0 --- /dev/null +++ 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 index 303d6cee9c32..990b045a125f 100644 --- 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 new file mode 100644 index 000000000000..9bf48a1cd8e5 --- /dev/null +++ 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 index 6a691abaf816..1de4ee8989a8 100644 --- 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 new file mode 100644 index 000000000000..44ece7d2cac7 --- /dev/null +++ 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 index 05cf8faacb0c..74c9b18d345e 100644 --- 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 new file mode 100644 index 000000000000..7699467d05ff --- /dev/null +++ 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 index 1dd0ba259cce..cb25df482b19 100644 --- 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 index 1c92d5171d99..8b137891791f 100644 --- a/packages/docusaurus/README.md +++ b/packages/docusaurus/README.md @@ -1 +1 @@ -# Docusaurus v2 + diff --git a/packages/lqip-loader/README.md b/packages/lqip-loader/README.md index 0a3b28d2a961..98be380602f2 100644 --- a/packages/lqip-loader/README.md +++ b/packages/lqip-loader/README.md @@ -2,19 +2,19 @@ Low Quality Image Placeholders (LQIP) loader for webpack. -### Installation +## Installation ``` npm install --save-dev @docusaurus/lqip-loader ``` -### Example +## Example Generating Base64 & dominant colours palette for a jpeg image imported in your JS bundle: > The large image file will be emitted & only 400byte of Base64 (if set to true in the loader options) will be bundled. -#### `webpack.config.js` +### `webpack.config.js` ```js { @@ -52,7 +52,7 @@ Generating Base64 & dominant colours palette for a jpeg image imported in your J } ``` -#### `your-app-module.js` +### `your-app-module.js` ```js import banner from './images/banner.jpg'; @@ -80,6 +80,6 @@ More history about the issue can be [found here](https://bugs.chromium.org/p/chr Alternatively, you can fill the container with a really cheap colour or gradient from the amazing palette we provide. -### Credits +## Credits -This package has been imported from [`@endiliey/lqip-loader`](https://github.com/endiliey/lqip-loader) which was a fork of original [`lqip-loader`](https://github.com/zouhir/lqip-loader) created exclusively for Docusaurus. +This package has been imported from [`@endiliey/lqip-loader`](https://github.com/endiliey/lqip-loader) which was a fork of the original [`lqip-loader`](https://github.com/zouhir/lqip-loader) created exclusively for Docusaurus. diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index 6051b1fd78c2..f51f02381963 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,7 +1,7 @@ { "name": "@docusaurus/lqip-loader", "version": "2.0.0-alpha.70", - "description": "Low Quality Image Placeholders (LQIP) loader for webpack", + "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "src/index.js", "publishConfig": { "access": "public" diff --git a/packages/stylelint-copyright/README.md b/packages/stylelint-copyright/README.md index 93c8b4d2dbf8..9e3d9010fd78 100644 --- a/packages/stylelint-copyright/README.md +++ b/packages/stylelint-copyright/README.md @@ -1,6 +1,6 @@ -# stylelint-copyright +# `stylelint-copyright` -stylelint plugin to check CSS files for a copyright header. +Stylelint plugin to check CSS files for a copyright header. ```css /* diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index 710a59e60555..3d0cfa673674 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,7 +1,7 @@ { "name": "stylelint-copyright", "version": "2.0.0-alpha.70", - "description": "stylelint plugin to check css files for a copyright header", + "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "index.js", "license": "MIT", "private": true,