From 48b996773c5bba382e9127b49b0868bdac450bc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Sat, 1 Aug 2020 15:24:46 +0200 Subject: [PATCH] chore(v2): prepare v2.0.0.alpha-61 release (#3182) * alpha 61 release * doc prettier * v2.0.0-alpha.61 --- CHANGELOG-2.x.md | 49 + lerna.json | 2 +- packages/docusaurus-1.x/package.json | 2 +- packages/docusaurus-init-1.x/package.json | 2 +- packages/docusaurus-init/package.json | 2 +- .../templates/bootstrap/package.json | 6 +- .../templates/classic/package.json | 6 +- .../templates/facebook/package.json | 6 +- packages/docusaurus-mdx-loader/package.json | 4 +- packages/docusaurus-migrate/package-lock.json | 2 +- packages/docusaurus-migrate/package.json | 2 +- .../package.json | 2 +- .../package.json | 6 +- .../package.json | 12 +- .../package.json | 14 +- .../package.json | 12 +- packages/docusaurus-plugin-debug/package.json | 6 +- .../package.json | 2 +- .../package.json | 2 +- .../package.json | 6 +- packages/docusaurus-plugin-pwa/package.json | 2 +- .../docusaurus-plugin-sitemap/package.json | 4 +- .../docusaurus-preset-bootstrap/package.json | 10 +- .../docusaurus-preset-classic/package.json | 20 +- .../docusaurus-theme-bootstrap/package.json | 2 +- .../docusaurus-theme-classic/package.json | 4 +- .../package.json | 2 +- .../package.json | 2 +- packages/docusaurus-types/package.json | 2 +- .../docusaurus-utils-validation/package.json | 2 +- packages/docusaurus-utils/package.json | 2 +- packages/docusaurus/package.json | 8 +- packages/lqip-loader/package.json | 2 +- packages/stylelint-copyright/package.json | 2 +- website-1.x/package.json | 4 +- website/docs/api/docusaurus.config.js.md | 7 +- website/package.json | 14 +- .../api/docusaurus.config.js.md | 329 ++++++ .../docusaurus-asset-example-banner.png | Bin 0 -> 69264 bytes .../assets/docusaurus-asset-example-pdf.pdf | Bin 0 -> 125786 bytes .../assets/docusaurus-asset-example.xyz | Bin 0 -> 125786 bytes .../version-2.0.0-alpha.61/blog.md | 221 ++++ .../version-2.0.0-alpha.61/cli.md | 124 ++ .../community/resources.md | 47 + .../community/support.md | 32 + .../version-2.0.0-alpha.61/community/team.md | 80 ++ .../version-2.0.0-alpha.61/configuration.md | 164 +++ .../version-2.0.0-alpha.61/contributing.md | 190 +++ .../version-2.0.0-alpha.61/deployment.md | 371 ++++++ .../design-principles.md | 34 + .../version-2.0.0-alpha.61/docs.md | 369 ++++++ .../version-2.0.0-alpha.61/docusaurus-core.md | 322 ++++++ .../guides/creating-pages.md | 122 ++ .../guides/migrating-from-v1-to-v2.md | 895 ++++++++++++++ .../version-2.0.0-alpha.61/installation.md | 139 +++ .../version-2.0.0-alpha.61/introduction.md | 113 ++ .../version-2.0.0-alpha.61/lifecycle-apis.md | 622 ++++++++++ .../markdown-features.mdx | 1026 +++++++++++++++++ .../version-2.0.0-alpha.61/presets.md | 142 +++ .../version-2.0.0-alpha.61/search.md | 128 ++ .../version-2.0.0-alpha.61/static-assets.md | 65 ++ .../version-2.0.0-alpha.61/styling-layout.md | 200 ++++ .../version-2.0.0-alpha.61/theme-classic.md | 334 ++++++ .../typescript-support.md | 50 + .../version-2.0.0-alpha.61/using-plugins.md | 929 +++++++++++++++ .../version-2.0.0-alpha.61/using-themes.md | 202 ++++ .../version-2.0.0-alpha.61/versioning.md | 158 +++ .../version-2.0.0-alpha.61-sidebars.json | 166 +++ website/versions.json | 1 + 69 files changed, 7717 insertions(+), 92 deletions(-) create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/api/docusaurus.config.js.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/assets/docusaurus-asset-example-banner.png create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/assets/docusaurus-asset-example-pdf.pdf create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/assets/docusaurus-asset-example.xyz create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/blog.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/cli.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/community/resources.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/community/support.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/community/team.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/configuration.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/contributing.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/deployment.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/design-principles.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/docs.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/docusaurus-core.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/guides/creating-pages.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/guides/migrating-from-v1-to-v2.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/installation.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/introduction.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/lifecycle-apis.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/markdown-features.mdx create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/presets.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/search.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/static-assets.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/styling-layout.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/theme-classic.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/typescript-support.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/using-plugins.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/using-themes.md create mode 100644 website/versioned_docs/version-2.0.0-alpha.61/versioning.md create mode 100644 website/versioned_sidebars/version-2.0.0-alpha.61-sidebars.json diff --git a/CHANGELOG-2.x.md b/CHANGELOG-2.x.md index 40a0226d94..d256f6bc61 100644 --- a/CHANGELOG-2.x.md +++ b/CHANGELOG-2.x.md @@ -1,5 +1,54 @@ # Docusaurus 2 Changelog +## 2.0.0-alpha.61 (2020-08-01) + +#### :rocket: New Feature + +- `docusaurus-types`, `docusaurus` + - [#3083](https://github.com/facebook/docusaurus/pull/3083) feat(v2): warn user when there are conflicting routes ([@teikjun](https://github.com/teikjun)) +- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-theme-classic`, `docusaurus-utils-validation`, `docusaurus-utils` + - [#3158](https://github.com/facebook/docusaurus/pull/3158) feat(v2): markdown pages ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#3127](https://github.com/facebook/docusaurus/pull/3127) feat(v2): dark mode toggle customization ([@Drewbi](https://github.com/Drewbi)) +- `docusaurus-theme-search-algolia` + - [#3166](https://github.com/facebook/docusaurus/pull/3166) feat(v2): improve Algolia search accessibility ([@francoischalifour](https://github.com/francoischalifour)) +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic` + - [#2359](https://github.com/facebook/docusaurus/pull/2359) feat(v2): support custom description for blog-only mode ([@zxuqian](https://github.com/zxuqian)) + +#### :bug: Bug Fix + +- `docusaurus-mdx-loader`, `docusaurus` + - [#3180](https://github.com/facebook/docusaurus/pull/3180) fix(v2): fix markdown images always using webpack url-loader ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#3171](https://github.com/facebook/docusaurus/pull/3171) fix(v2): tab label showing outline & background when clicked ([@mdfaizan7](https://github.com/mdfaizan7)) +- `docusaurus-init`, `docusaurus-theme-classic` + - [#3168](https://github.com/facebook/docusaurus/pull/3168) fix(v2): fix link items refusing attributes like target, rel etc... ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-plugin-debug`, `docusaurus-plugin-ideal-image`, `docusaurus-plugin-sitemap`, `docusaurus-preset-bootstrap`, `docusaurus-preset-classic`, `docusaurus-theme-classic`, `docusaurus-theme-search-algolia`, `docusaurus` + - [#3162](https://github.com/facebook/docusaurus/pull/3162) fix(v2): inability for users to pin their docusaurus version ([@BuckyMaler](https://github.com/BuckyMaler)) + +#### :memo: Documentation + +- [#3163](https://github.com/facebook/docusaurus/pull/3163) docs(v2): showcase user questdb ([@mpsq](https://github.com/mpsq)) + +#### :house: Internal + +- Other + - [#3164](https://github.com/facebook/docusaurus/pull/3164) chore(deps): bump elliptic from 6.5.2 to 6.5.3 ([@dependabot[bot]](https://github.com/apps/dependabot)) + - [#3157](https://github.com/facebook/docusaurus/pull/3157) chore(v2): remove alpha 59 doc ([@slorber](https://github.com/slorber)) +- `docusaurus-1.x`, `docusaurus-init-1.x`, `docusaurus-init`, `docusaurus-mdx-loader`, `docusaurus-migrate`, `docusaurus-module-type-aliases`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-plugin-debug`, `docusaurus-plugin-google-analytics`, `docusaurus-plugin-google-gtag`, `docusaurus-plugin-ideal-image`, `docusaurus-plugin-pwa`, `docusaurus-plugin-sitemap`, `docusaurus-preset-bootstrap`, `docusaurus-preset-classic`, `docusaurus-theme-bootstrap`, `docusaurus-theme-classic`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia`, `docusaurus-types`, `docusaurus-utils`, `docusaurus`, `lqip-loader`, `stylelint-copyright` + - [#3154](https://github.com/facebook/docusaurus/pull/3154) chore(v2): prepare v2.0.0.alpha-60 release ([@slorber](https://github.com/slorber)) + +#### Committers: 8 + +- Bucky Maler ([@BuckyMaler](https://github.com/BuckyMaler)) +- Drew Alexander ([@Drewbi](https://github.com/Drewbi)) +- Faizan ([@mdfaizan7](https://github.com/mdfaizan7)) +- FranΓ§ois Chalifour ([@francoischalifour](https://github.com/francoischalifour)) +- MΓ©ril ([@mpsq](https://github.com/mpsq)) +- SΓ©bastien Lorber ([@slorber](https://github.com/slorber)) +- Teik Jun ([@teikjun](https://github.com/teikjun)) +- Xuqian ([@zxuqian](https://github.com/zxuqian)) ✨ Done in 3.58s. + ## 2.0.0-alpha.60 (2020-07-29) #### :rocket: New Feature diff --git a/lerna.json b/lerna.json index 1c5bf6083f..ef4d2ddadf 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "npmClient": "yarn", "useWorkspaces": true, "changelog": { diff --git a/packages/docusaurus-1.x/package.json b/packages/docusaurus-1.x/package.json index dd25d312ba..f957f938d6 100644 --- a/packages/docusaurus-1.x/package.json +++ b/packages/docusaurus-1.x/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "license": "MIT", "keywords": [ "documentation", diff --git a/packages/docusaurus-init-1.x/package.json b/packages/docusaurus-init-1.x/package.json index 63ce6c3745..3f118f3ee1 100644 --- a/packages/docusaurus-init-1.x/package.json +++ b/packages/docusaurus-init-1.x/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-init", "description": "Initialization script for Docusaurus", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "license": "MIT", "preferGlobal": true, "keywords": [ diff --git a/packages/docusaurus-init/package.json b/packages/docusaurus-init/package.json index e11af6f786..8f3d36e480 100644 --- a/packages/docusaurus-init/package.json +++ b/packages/docusaurus-init/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/init", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Create Docusaurus app easily", "repository": { "type": "git", diff --git a/packages/docusaurus-init/templates/bootstrap/package.json b/packages/docusaurus-init/templates/bootstrap/package.json index ce271a86b9..7b084a3aef 100644 --- a/packages/docusaurus-init/templates/bootstrap/package.json +++ b/packages/docusaurus-init/templates/bootstrap/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-bootstrap-template", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -11,8 +11,8 @@ "serve": "docusaurus serve" }, "dependencies": { - "@docusaurus/core": "^2.0.0-alpha.60", - "@docusaurus/preset-bootstrap": "^2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/preset-bootstrap": "^2.0.0-alpha.61", "@mdx-js/react": "^1.5.8", "classnames": "^2.2.6", "react": "^16.8.4", diff --git a/packages/docusaurus-init/templates/classic/package.json b/packages/docusaurus-init/templates/classic/package.json index 9b033dd3dd..5a705261c7 100644 --- a/packages/docusaurus-init/templates/classic/package.json +++ b/packages/docusaurus-init/templates/classic/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-template", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -11,8 +11,8 @@ "serve": "docusaurus serve" }, "dependencies": { - "@docusaurus/core": "^2.0.0-alpha.60", - "@docusaurus/preset-classic": "^2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/preset-classic": "^2.0.0-alpha.61", "@mdx-js/react": "^1.5.8", "clsx": "^1.1.1", "react": "^16.8.4", diff --git a/packages/docusaurus-init/templates/facebook/package.json b/packages/docusaurus-init/templates/facebook/package.json index a31444a5aa..1a239c4306 100644 --- a/packages/docusaurus-init/templates/facebook/package.json +++ b/packages/docusaurus-init/templates/facebook/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-facebook-template", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "prettier:diff": "prettier --config .prettierrc --list-different \"**/*.{js,md}\"" }, "dependencies": { - "@docusaurus/core": "^2.0.0-alpha.60", - "@docusaurus/preset-classic": "^2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/preset-classic": "^2.0.0-alpha.61", "@mdx-js/react": "^1.5.8", "clsx": "^1.1.1", "react": "^16.8.4", diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json index 41c60e7306..5f5ab0be42 100644 --- a/packages/docusaurus-mdx-loader/package.json +++ b/packages/docusaurus-mdx-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/mdx-loader", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docusaurus Loader for MDX", "main": "src/index.js", "publishConfig": { @@ -10,7 +10,7 @@ "dependencies": { "@babel/parser": "^7.9.4", "@babel/traverse": "^7.9.0", - "@docusaurus/core": "^2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", "@mdx-js/mdx": "^1.5.8", "@mdx-js/react": "^1.5.8", "escape-html": "^1.0.3", diff --git a/packages/docusaurus-migrate/package-lock.json b/packages/docusaurus-migrate/package-lock.json index d46049c9f7..7755654eb6 100644 --- a/packages/docusaurus-migrate/package-lock.json +++ b/packages/docusaurus-migrate/package-lock.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/migrate", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json index d63a620f91..7446a23f3f 100644 --- a/packages/docusaurus-migrate/package.json +++ b/packages/docusaurus-migrate/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/migrate", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "A cli tool to migrate between different version of docusuarus", "main": "lib/index.js", "license": "MIT", diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index 33967d9620..3c62f31609 100644 --- a/packages/docusaurus-module-type-aliases/package.json +++ b/packages/docusaurus-module-type-aliases/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/module-type-aliases", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docusaurus module type aliases", "types": "./src/index.d.ts", "publishConfig": { diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index 7d8d2e36ec..269f85b80f 100644 --- a/packages/docusaurus-plugin-client-redirects/package.json +++ b/packages/docusaurus-plugin-client-redirects/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-client-redirects", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Client redirects plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -12,8 +12,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60", + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61", "@hapi/joi": "^17.1.1", "@types/hapi__joi": "^17.1.2", "chalk": "^3.0.0", diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json index 03a260d94a..634762025a 100644 --- a/packages/docusaurus-plugin-content-blog/package.json +++ b/packages/docusaurus-plugin-content-blog/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-blog", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Blog plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -15,11 +15,11 @@ "@types/hapi__joi": "^17.1.2" }, "dependencies": { - "@docusaurus/core": "2.0.0-alpha.60", - "@docusaurus/mdx-loader": "2.0.0-alpha.60", - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60", - "@docusaurus/utils-validation": "2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/mdx-loader": "^2.0.0-alpha.61", + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61", + "@docusaurus/utils-validation": "^2.0.0-alpha.61", "@hapi/joi": "^17.1.1", "feed": "^4.1.0", "fs-extra": "^8.1.0", diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index 598a4cecad..345ed7e98f 100644 --- a/packages/docusaurus-plugin-content-docs/package.json +++ b/packages/docusaurus-plugin-content-docs/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-docs", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docs content plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -12,17 +12,17 @@ }, "license": "MIT", "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-alpha.60", + "@docusaurus/module-type-aliases": "^2.0.0-alpha.61", "@types/hapi__joi": "^17.1.2", "commander": "^5.0.0", "picomatch": "^2.1.1" }, "dependencies": { - "@docusaurus/core": "2.0.0-alpha.60", - "@docusaurus/mdx-loader": "2.0.0-alpha.60", - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60", - "@docusaurus/utils-validation": "2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/mdx-loader": "^2.0.0-alpha.61", + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61", + "@docusaurus/utils-validation": "^2.0.0-alpha.61", "@hapi/joi": "17.1.1", "execa": "^3.4.0", "fs-extra": "^8.1.0", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index 1c8b03f81a..92836d58ac 100644 --- a/packages/docusaurus-plugin-content-pages/package.json +++ b/packages/docusaurus-plugin-content-pages/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-pages", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Pages content plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -15,13 +15,13 @@ "@types/hapi__joi": "^17.1.2" }, "dependencies": { - "@docusaurus/mdx-loader": "2.0.0-alpha.60", - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60", - "@docusaurus/utils-validation": "2.0.0-alpha.60", + "@docusaurus/mdx-loader": "^2.0.0-alpha.61", + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61", + "@docusaurus/utils-validation": "^2.0.0-alpha.61", "@hapi/joi": "17.1.1", - "loader-utils": "^1.2.3", "globby": "^10.0.1", + "loader-utils": "^1.2.3", "remark-admonitions": "^1.2.1" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 1fa5ab1d98..edf4a03bca 100644 --- a/packages/docusaurus-plugin-debug/package.json +++ b/packages/docusaurus-plugin-debug/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-debug", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Debug plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -12,8 +12,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60" + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61" }, "peerDependencies": { "@docusaurus/core": "^2.0.0", diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index e4b3a630cf..f3c09c5a74 100644 --- a/packages/docusaurus-plugin-google-analytics/package.json +++ b/packages/docusaurus-plugin-google-analytics/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-analytics", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Global analytics (analytics.js) plugin for Docusaurus", "main": "src/index.js", "publishConfig": { diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index 4d59b71ffc..c5a28a15c1 100644 --- a/packages/docusaurus-plugin-google-gtag/package.json +++ b/packages/docusaurus-plugin-google-gtag/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-gtag", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Global Site Tag (gtag.js) plugin for Docusaurus", "main": "src/index.js", "publishConfig": { diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index 7d61b75bb7..5380f1cead 100644 --- a/packages/docusaurus-plugin-ideal-image/package.json +++ b/packages/docusaurus-plugin-ideal-image/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-ideal-image", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)", "main": "lib/index.js", "scripts": { @@ -12,11 +12,11 @@ }, "license": "MIT", "devDependencies": { - "@docusaurus/types": "2.0.0-alpha.60", + "@docusaurus/types": "^2.0.0-alpha.61", "fs-extra": "^9.0.0" }, "dependencies": { - "@docusaurus/lqip-loader": "2.0.0-alpha.60", + "@docusaurus/lqip-loader": "^2.0.0-alpha.61", "@endiliey/react-ideal-image": "^0.0.11", "@endiliey/responsive-loader": "^1.3.2", "react-waypoint": "^9.0.2", diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 473c944fff..7491375790 100644 --- a/packages/docusaurus-plugin-pwa/package.json +++ b/packages/docusaurus-plugin-pwa/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-pwa", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docusaurus Plugin to add PWA support", "main": "src/index.js", "publishConfig": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index b916394dc0..6af7605fd5 100644 --- a/packages/docusaurus-plugin-sitemap/package.json +++ b/packages/docusaurus-plugin-sitemap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-sitemap", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Simple sitemap generation plugin for Docusaurus", "main": "lib/index.js", "scripts": { @@ -15,7 +15,7 @@ "@types/hapi__joi": "^17.1.2" }, "dependencies": { - "@docusaurus/types": "2.0.0-alpha.60", + "@docusaurus/types": "^2.0.0-alpha.61", "@hapi/joi": "17.1.1", "fs-extra": "^8.1.0", "sitemap": "^3.2.2" diff --git a/packages/docusaurus-preset-bootstrap/package.json b/packages/docusaurus-preset-bootstrap/package.json index dd47a579bc..d603febfe2 100644 --- a/packages/docusaurus-preset-bootstrap/package.json +++ b/packages/docusaurus-preset-bootstrap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/preset-bootstrap", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Preset for bootstrap Docusaurus", "main": "src/index.js", "license": "MIT", @@ -8,10 +8,10 @@ "access": "public" }, "dependencies": { - "@docusaurus/plugin-content-blog": "2.0.0-alpha.60", - "@docusaurus/plugin-content-docs": "2.0.0-alpha.60", - "@docusaurus/plugin-content-pages": "2.0.0-alpha.60", - "@docusaurus/theme-bootstrap": "2.0.0-alpha.60" + "@docusaurus/plugin-content-blog": "^2.0.0-alpha.61", + "@docusaurus/plugin-content-docs": "^2.0.0-alpha.61", + "@docusaurus/plugin-content-pages": "^2.0.0-alpha.61", + "@docusaurus/theme-bootstrap": "^2.0.0-alpha.61" }, "peerDependencies": { "@docusaurus/core": "^2.0.0", diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index bd6cdeea32..2635e00c41 100644 --- a/packages/docusaurus-preset-classic/package.json +++ b/packages/docusaurus-preset-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/preset-classic", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Preset for classic Docusaurus", "main": "src/index.js", "publishConfig": { @@ -8,15 +8,15 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/plugin-content-blog": "2.0.0-alpha.60", - "@docusaurus/plugin-content-docs": "2.0.0-alpha.60", - "@docusaurus/plugin-content-pages": "2.0.0-alpha.60", - "@docusaurus/plugin-debug": "2.0.0-alpha.60", - "@docusaurus/plugin-google-analytics": "2.0.0-alpha.60", - "@docusaurus/plugin-google-gtag": "2.0.0-alpha.60", - "@docusaurus/plugin-sitemap": "2.0.0-alpha.60", - "@docusaurus/theme-classic": "2.0.0-alpha.60", - "@docusaurus/theme-search-algolia": "2.0.0-alpha.60" + "@docusaurus/plugin-content-blog": "^2.0.0-alpha.61", + "@docusaurus/plugin-content-docs": "^2.0.0-alpha.61", + "@docusaurus/plugin-content-pages": "^2.0.0-alpha.61", + "@docusaurus/plugin-debug": "^2.0.0-alpha.61", + "@docusaurus/plugin-google-analytics": "^2.0.0-alpha.61", + "@docusaurus/plugin-google-gtag": "^2.0.0-alpha.61", + "@docusaurus/plugin-sitemap": "^2.0.0-alpha.61", + "@docusaurus/theme-classic": "^2.0.0-alpha.61", + "@docusaurus/theme-search-algolia": "^2.0.0-alpha.61" }, "peerDependencies": { "@docusaurus/core": "^2.0.0", diff --git a/packages/docusaurus-theme-bootstrap/package.json b/packages/docusaurus-theme-bootstrap/package.json index ec75173f0e..f2fb2da39e 100644 --- a/packages/docusaurus-theme-bootstrap/package.json +++ b/packages/docusaurus-theme-bootstrap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-bootstrap", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Bootstrap theme for docusaurus", "main": "src/index.js", "license": "MIT", diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json index 5255b67606..15fcbe1f43 100644 --- a/packages/docusaurus-theme-classic/package.json +++ b/packages/docusaurus-theme-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-classic", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Classic theme for Docusaurus", "main": "src/index.js", "publishConfig": { @@ -29,7 +29,7 @@ "react-toggle": "^4.1.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-alpha.60", + "@docusaurus/module-type-aliases": "^2.0.0-alpha.61", "@types/hapi__joi": "^17.1.2" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index 86946db86f..124d9789a2 100644 --- a/packages/docusaurus-theme-live-codeblock/package.json +++ b/packages/docusaurus-theme-live-codeblock/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-live-codeblock", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Docusaurus Live CodeBlock", "main": "src/index.js", "publishConfig": { diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index 39c5614974..aea1064d40 100644 --- a/packages/docusaurus-theme-search-algolia/package.json +++ b/packages/docusaurus-theme-search-algolia/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-search-algolia", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Algolia search component for Docusaurus", "main": "src/index.js", "publishConfig": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index 47b182c954..49b2703c5c 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Common used typings for Docusaurus packages", "main": "./src/index.js", "types": "./src/index.d.ts", diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index 1ca47d0516..d95aa07b06 100644 --- a/packages/docusaurus-utils-validation/package.json +++ b/packages/docusaurus-utils-validation/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-validation", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Node validation utility functions for Docusaurus packages", "main": "./lib/index.js", "types": "./lib/index.d.ts", diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index f7e2ae75e1..5785dfc793 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Node utility functions for Docusaurus packages", "main": "./lib/index.js", "types": "./lib/index.d.ts", diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index 94014a2c4b..df19694911 100644 --- a/packages/docusaurus/package.json +++ b/packages/docusaurus/package.json @@ -1,7 +1,7 @@ { "name": "@docusaurus/core", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "license": "MIT", "publishConfig": { "access": "public" @@ -30,7 +30,7 @@ "url": "https://github.com/facebook/docusaurus/issues" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-alpha.60", + "@docusaurus/module-type-aliases": "^2.0.0-alpha.61", "@types/detect-port": "^1.3.0", "@types/hapi__joi": "^17.1.2" }, @@ -45,8 +45,8 @@ "@babel/preset-typescript": "^7.9.0", "@babel/runtime": "^7.9.2", "@babel/runtime-corejs3": "^7.10.4", - "@docusaurus/types": "2.0.0-alpha.60", - "@docusaurus/utils": "2.0.0-alpha.60", + "@docusaurus/types": "^2.0.0-alpha.61", + "@docusaurus/utils": "^2.0.0-alpha.61", "@endiliey/static-site-generator-webpack-plugin": "^4.0.0", "@hapi/joi": "^17.1.1", "@svgr/webpack": "^5.4.0", diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index ee7f3caebb..530981a46d 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/lqip-loader", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "Low Quality Image Placeholders (LQIP) loader for webpack", "main": "src/index.js", "publishConfig": { diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index 2a40b1990e..f8f1031942 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "description": "stylelint plugin to check css files for a copyright header", "main": "index.js", "license": "MIT", diff --git a/website-1.x/package.json b/website-1.x/package.json index 8535489fbc..e11dc56ff6 100644 --- a/website-1.x/package.json +++ b/website-1.x/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-1-website", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "private": true, "scripts": { "start": "docusaurus-start", @@ -14,6 +14,6 @@ "crowdin-download": "crowdin --config ../crowdin.yaml download -b master" }, "dependencies": { - "docusaurus": "^2.0.0-alpha.60" + "docusaurus": "^2.0.0-alpha.61" } } diff --git a/website/docs/api/docusaurus.config.js.md b/website/docs/api/docusaurus.config.js.md index c7422f7ab9..08d0041109 100644 --- a/website/docs/api/docusaurus.config.js.md +++ b/website/docs/api/docusaurus.config.js.md @@ -173,11 +173,12 @@ module.exports = { respectPrefersColorScheme: true, switchConfig: { darkIcon: 'πŸŒ™', - darkIconStyle: { // Style object passed to inline CSS - // For more information about styling options visit: https://reactjs.org/docs/dom-elements.html#style + lightIcon: '\u2600', + // React inline style objects + // see https://reactjs.org/docs/dom-elements.html#style + darkIconStyle: { marginLeft: '2px', }, - lightIcon: '\u2600', lightIconStyle: { marginLeft: '1px', }, diff --git a/website/package.json b/website/package.json index af128aff4f..65b246ff1a 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-website", - "version": "2.0.0-alpha.60", + "version": "2.0.0-alpha.61", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -17,12 +17,12 @@ "netlify:test": "yarn netlify:build:deployPreview && yarn netlify dev --debug" }, "dependencies": { - "@docusaurus/core": "^2.0.0-alpha.60", - "@docusaurus/plugin-client-redirects": "^2.0.0-alpha.60", - "@docusaurus/plugin-ideal-image": "^2.0.0-alpha.60", - "@docusaurus/plugin-pwa": "^2.0.0-alpha.60", - "@docusaurus/preset-classic": "^2.0.0-alpha.60", - "@docusaurus/theme-live-codeblock": "^2.0.0-alpha.60", + "@docusaurus/core": "^2.0.0-alpha.61", + "@docusaurus/plugin-client-redirects": "^2.0.0-alpha.61", + "@docusaurus/plugin-ideal-image": "^2.0.0-alpha.61", + "@docusaurus/plugin-pwa": "^2.0.0-alpha.61", + "@docusaurus/preset-classic": "^2.0.0-alpha.61", + "@docusaurus/theme-live-codeblock": "^2.0.0-alpha.61", "clsx": "^1.1.1", "color": "^3.1.2", "npm-to-yarn": "^1.0.0-2", diff --git a/website/versioned_docs/version-2.0.0-alpha.61/api/docusaurus.config.js.md b/website/versioned_docs/version-2.0.0-alpha.61/api/docusaurus.config.js.md new file mode 100644 index 0000000000..647c664d29 --- /dev/null +++ b/website/versioned_docs/version-2.0.0-alpha.61/api/docusaurus.config.js.md @@ -0,0 +1,329 @@ +--- +id: docusaurus.config.js +title: docusaurus.config.js +description: API reference for Docusaurus configuration file. +slug: /docusaurus.config.js +--- + +## Overview + +`docusaurus.config.js` contains configurations for your site and is placed in the root directory of your site. + +## Required fields + +### `title` + +- Type: `string` + +Title for your website. + +```js title="docusaurus.config.js" +module.exports = { + title: 'Docusaurus', +}; +``` + +### `favicon` + +- Type: `string` + +URL for site favicon. Example: + +```js title="docusaurus.config.js" +module.exports = { + favicon: 'https://v2.docusaurus.io/favicon.ico', +}; +``` + +You can also use the favicon URL relative to the `static` directory of your site. For example, your site has the following directory structure: + +```bash +. +β”œβ”€β”€ README.md +β”œ # ... other files in root directory +└─ static + └── img + └── favicon.ico +``` + +So you can refer it like below: + +```js title="docusaurus.config.js" +module.exports = { + favicon: 'img/favicon.ico', +}; +``` + +### `url` + +- Type: `string` + +URL for your website. This can also be considered the top-level hostname. For example, `https://facebook.github.io` is the URL of https://facebook.github.io/metro/, and `https://docusaurus.io` is the URL for https://docusaurus.io. This field is related to the [baseUrl](#baseurl) field. + +```js title="docusaurus.config.js" +module.exports = { + url: 'https://docusaurus.io', +}; +``` + +### `baseUrl` + +- Type: `string` + +Base URL for your site. This can also be considered the path after the host. For example, `/metro/` is the baseUrl of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to `/`. This field is related to the [url](#url) field. + +```js title="docusaurus.config.js" +module.exports = { + baseUrl: '/', +}; +``` + +## Optional fields + +### `onBrokenLinks` + +- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'` + +The behavior of Docusaurus, when it detects any broken link. + +By default, it throws an error, to ensure you never ship any broken link, but you can lower this security if needed. + +:::note + +The broken links detection is only available for a production build (`docusaurus build`). + +::: + +### `onDuplicateRoutes` + +- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'` + +The behavior of Docusaurus when it detects any [duplicate routes](/guides/creating-pages.md#duplicate-routes). + +By default, it displays a warning after you run `yarn start` or `yarn build`. + +### `tagline` + +- Type: `string` + +The tagline for your website. + +```js title="docusaurus.config.js" +module.exports = { + tagline: + 'Docusaurus makes it easy to maintain Open Source documentation websites.', +}; +``` + +### `organizationName` + +- Type: `string` + +The GitHub user or organization that owns the repository. Used by the deployment command. + +```js title="docusaurus.config.js" +module.exports = { + // Docusaurus' organization is facebook + organizationName: 'facebook', +}; +``` + +### `projectName` + +- Type: `string` + +The name of the GitHub repository. Used by the deployment command. + +```js title="docusaurus.config.js" +module.exports = { + projectName: 'docusaurus', +}; +``` + +### `githubHost` + +- Type: `string` + +The hostname of your server. Useful if you are using GitHub Enterprise. + +```js title="docusaurus.config.js" +module.exports = { + githubHost: 'github.com', +}; +``` + +### `themeConfig` + +- Type: `Object` + + + +An object containing data needed by the theme you use. + +For Docusaurus' default theme _classic_, we use `themeConfig` to customize your navbar and footer links: + +Example: + +```js title="docusaurus.config.js" +module.exports = { + themeConfig: { + colorMode: { + defaultMode: 'light', + disableSwitch: false, + respectPrefersColorScheme: true, + switchConfig: { + darkIcon: 'πŸŒ™', + darkIconStyle: { + // Style object passed to inline CSS + // For more information about styling options visit: https://reactjs.org/docs/dom-elements.html#style + marginLeft: '2px', + }, + lightIcon: '\u2600', + lightIconStyle: { + marginLeft: '1px', + }, + }, + }, + navbar: { + title: 'Site Title', + logo: { + alt: 'Site Logo', + src: 'img/logo.svg', + }, + items: [ + { + to: 'docs/docusaurus.config.js', + activeBasePath: 'docs', + label: 'docusaurus.config.js', + position: 'left', + }, + // ... other links + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Docs', + items: [ + { + label: 'Docs', + to: 'docs/doc1', + }, + ], + }, + // ... other links + ], + logo: { + alt: 'Facebook Open Source Logo', + src: 'https://docusaurus.io/img/oss_logo.png', + }, + copyright: `Copyright Β© ${new Date().getFullYear()} Facebook, Inc.`, // You can also put own HTML here + }, + }, +}; +``` + +### `plugins` + + + +- Type: `any[]` + +```js title="docusaurus.config.js" +module.exports = { + plugins: [], +}; +``` + +### `themes` + + + +- Type: `any[]` + +```js title="docusaurus.config.js" +module.exports = { + themes: [], +}; +``` + +### `presets` + + + +- Type: `any[]` + +```js title="docusaurus.config.js" +module.exports = { + presets: [], +}; +``` + +### `customFields` + +Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom field, define it on `customFields`. + +- Type: `Object` + +```js title="docusaurus.config.js" +module.exports = { + customFields: { + admin: 'endi', + superman: 'lol', + }, +}; +``` + +Attempting to add unknown field in the config will lead to error in build time: + +```bash +Error: The field(s) 'foo', 'bar' are not recognized in docusaurus.config.js +``` + +### `scripts` + +An array of scripts to load. The values can be either strings or plain objects of attribute-value maps. The `