3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 02:08:36 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
* 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>
This commit is contained in:
Reece Dunham 2021-01-14 11:16:26 -05:00 • committed by GitHub
parent c94b44559c
commit 0252d01ebb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
52 changed files with 154 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
packages/docusaurus-cssnano-preset/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/cssnano-preset`
An advanced cssnano preset for maximum optimization.

2
packages/docusaurus-cssnano-preset/package.json
View file

@ -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": {

7
packages/docusaurus-init/README.md Normal file
View file

@ -0,0 +1,7 @@
# `@docusaurus/init`
Create Docusaurus apps easily.
## Usage
Please see the [installation documentation](https://v2.docusaurus.io/docs/installation).

2
packages/docusaurus-init/package.json
View file

@ -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",

2
packages/docusaurus-mdx-loader/README.md
View file

@ -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

7
packages/docusaurus-migrate/README.md Normal file
View file

@ -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.

2
packages/docusaurus-migrate/package.json
View file

@ -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": {

3
packages/docusaurus-module-type-aliases/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/module-type-aliases`
Docusaurus module type aliases.

2
packages/docusaurus-module-type-aliases/package.json
View file

@ -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"

7
packages/docusaurus-plugin-client-redirects/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-client-redirects/package.json
View file

@ -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",

7
packages/docusaurus-plugin-content-blog/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-content-blog/package.json
View file

@ -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": {

7
packages/docusaurus-plugin-content-docs/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-content-docs/package.json
View file

@ -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": {

7
packages/docusaurus-plugin-content-pages/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-content-pages/package.json
View file

@ -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": {

7
packages/docusaurus-plugin-debug/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-debug/package.json
View file

@ -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",

7
packages/docusaurus-plugin-google-analytics/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-google-analytics/package.json
View file

@ -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"

7
packages/docusaurus-plugin-google-gtag/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-google-gtag/package.json
View file

@ -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"

2
packages/docusaurus-plugin-ideal-image/README.md
View file

@ -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

2
packages/docusaurus-plugin-ideal-image/package.json
View file

@ -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",

7
packages/docusaurus-plugin-pwa/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-pwa/package.json
View file

@ -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"

7
packages/docusaurus-plugin-sitemap/README.md Normal file
View file

@ -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).

2
packages/docusaurus-plugin-sitemap/package.json
View file

@ -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",

7
packages/docusaurus-preset-bootstrap/README.md Normal file
View file

@ -0,0 +1,7 @@
# `@docusaurus/preset-bootstrap`
Bootstrap preset for Docusaurus.
## Usage
See [presets documentation](https://v2.docusaurus.io/docs/presets).

2
packages/docusaurus-preset-bootstrap/package.json
View file

@ -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": {

7
packages/docusaurus-preset-classic/README.md Normal file
View file

@ -0,0 +1,7 @@
# `@docusaurus/preset-classic`
Classic preset for Docusaurus.
## Usage
See [presets documentation](https://v2.docusaurus.io/docs/presets).

2
packages/docusaurus-preset-classic/package.json
View file

@ -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"

2
packages/docusaurus-remark-plugin-npm2yarn/package.json
View file

@ -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"

2
packages/docusaurus-theme-bootstrap/package.json
View file

@ -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",

3
packages/docusaurus-theme-common/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/theme-common`
Common code for Docusaurus themes.

2
packages/docusaurus-theme-common/package.json
View file

@ -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": {

2
packages/docusaurus-theme-live-codeblock/README.md
View file

@ -1,4 +1,4 @@
## Docusaurus Live Codeblock
# Docusaurus Live Codeblock
You can create live code editors with a code block `live` meta string.

2
packages/docusaurus-theme-live-codeblock/package.json
View file

@ -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"

7
packages/docusaurus-theme-search-algolia/README.md Normal file
View file

@ -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).

2
packages/docusaurus-theme-search-algolia/package.json
View file

@ -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"

3
packages/docusaurus-types/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/types`
Common types for Docusaurus packages.

2
packages/docusaurus-types/package.json
View file

@ -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": {

3
packages/docusaurus-utils-validation/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/utils-validation`
Node validation utility functions for Docusaurus packages.

2
packages/docusaurus-utils-validation/package.json
View file

@ -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": {

3
packages/docusaurus-utils/README.md Normal file
View file

@ -0,0 +1,3 @@
# `@docusaurus/utils`
Node validation utility functions for Docusaurus packages.

2
packages/docusaurus-utils/package.json
View file

@ -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": {

2
packages/docusaurus/README.md
View file

@ -1 +1 @@
# Docusaurus v2

12
packages/lqip-loader/README.md
View file

@ -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.

2
packages/lqip-loader/package.json
View file

@ -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"

4
packages/stylelint-copyright/README.md
View file

@ -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
/*

2
packages/stylelint-copyright/package.json
View file

@ -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,