Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Jan 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/docusaurus-cssnano-preset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/cssnano-preset`

An advanced cssnano preset for maximum optimization.
2 changes: 1 addition & 1 deletion packages/docusaurus-cssnano-preset/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-init/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# `@docusaurus/init`

Create Docusaurus apps easily.

## Usage

Please see the [installation documentation](https://v2.docusaurus.io/docs/installation).
2 changes: 1 addition & 1 deletion packages/docusaurus-init/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-mdx-loader/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-migrate/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-migrate/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-module-type-aliases/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/module-type-aliases`

Docusaurus module type aliases.
2 changes: 1 addition & 1 deletion packages/docusaurus-module-type-aliases/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-client-redirects/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-client-redirects/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-content-blog/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-blog/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-content-docs/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-docs/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-content-pages/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-content-pages/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-debug/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-debug/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-google-analytics/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-google-analytics/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-google-gtag/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-google-gtag/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-ideal-image/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-ideal-image/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-pwa/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-pwa/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-plugin-sitemap/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-plugin-sitemap/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-preset-bootstrap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# `@docusaurus/preset-bootstrap`

Bootstrap preset for Docusaurus.

## Usage

See [presets documentation](https://v2.docusaurus.io/docs/presets).
2 changes: 1 addition & 1 deletion packages/docusaurus-preset-bootstrap/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-preset-classic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# `@docusaurus/preset-classic`

Classic preset for Docusaurus.

## Usage

See [presets documentation](https://v2.docusaurus.io/docs/presets).
2 changes: 1 addition & 1 deletion packages/docusaurus-preset-classic/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-remark-plugin-npm2yarn/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-bootstrap/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-theme-common/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/theme-common`

Common code for Docusaurus themes.
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-common/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-live-codeblock/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Docusaurus Live Codeblock
# Docusaurus Live Codeblock

You can create live code editors with a code block `live` meta string.

Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-theme-live-codeblock/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
7 changes: 7 additions & 0 deletions packages/docusaurus-theme-search-algolia/README.md
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/docusaurus-theme-search-algolia/package.json
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/types`

Common types for Docusaurus packages.
2 changes: 1 addition & 1 deletion packages/docusaurus-types/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-utils-validation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/utils-validation`

Node validation utility functions for Docusaurus packages.
2 changes: 1 addition & 1 deletion packages/docusaurus-utils-validation/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
3 changes: 3 additions & 0 deletions packages/docusaurus-utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# `@docusaurus/utils`

Node validation utility functions for Docusaurus packages.
2 changes: 1 addition & 1 deletion packages/docusaurus-utils/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Docusaurus v2

Loading