diff --git a/CHANGELOG.md b/CHANGELOG.md index 22ab4e6fa124..2ca7ac9a48b8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,181 @@ # Docusaurus 2 Changelog +## 2.0.0-beta.22 (2022-07-08) + +#### :boom: Breaking Change + +- `docusaurus-theme-classic` + - [#7740](https://github.com/facebook/docusaurus/pull/7740) refactor(theme): nest theme icons under subfolder @theme/Icon/\* ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#7716](https://github.com/facebook/docusaurus/pull/7716) refactor(theme): split BlogPostItem into smaller theme subcomponents ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-search-algolia` + - [#7660](https://github.com/facebook/docusaurus/pull/7660) refactor(theme-common): split package into public/internal API entrypoints ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#7644](https://github.com/facebook/docusaurus/pull/7644) refactor(docs,theme): split DocItem comp, useDoc hook ([@slorber](https://github.com/slorber)) +- `docusaurus-logger`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-types`, `docusaurus-utils`, `docusaurus` + - [#7642](https://github.com/facebook/docusaurus/pull/7642) refactor: remove "error" reporting level, move reportMessage to logger ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-theme-classic`, `docusaurus-utils-validation`, `docusaurus` + - [#7152](https://github.com/facebook/docusaurus/pull/7152) refactor: handle all admonitions via JSX component ([@lex111](https://github.com/lex111)) + +#### :rocket: New Feature + +- `docusaurus-theme-translations` + - [#7732](https://github.com/facebook/docusaurus/pull/7732) feat(theme-translations): Dutch translation ([@reinvanhaaren](https://github.com/reinvanhaaren)) + - [#7715](https://github.com/facebook/docusaurus/pull/7715) feat(theme-translations): Swedish translation ([@johnie](https://github.com/johnie)) +- `docusaurus-theme-search-algolia`, `docusaurus-theme-translations` + - [#7666](https://github.com/facebook/docusaurus/pull/7666) feat(algolia-search): allow translating search modal ([@forresst](https://github.com/forresst)) +- `create-docusaurus`, `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#7643](https://github.com/facebook/docusaurus/pull/7643) feat(theme-classic): themeConfig navbar/footer logos accept className/style + update Meta Open-Source Logo ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-client-redirects` + - [#7649](https://github.com/facebook/docusaurus/pull/7649) feat(client-redirects): make plugin respect onDuplicateRoutes config ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-types`, `docusaurus-utils`, `docusaurus` + - [#7624](https://github.com/facebook/docusaurus/pull/7624) feat: allow customizing localization path of each locale ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus` + - [#7581](https://github.com/facebook/docusaurus/pull/7581) feat(core): allow opting out of HTML minification ([@alexandernst](https://github.com/alexandernst)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#7557](https://github.com/facebook/docusaurus/pull/7557) feat: allow specifying custom target for FooterLogo ([@vannyle](https://github.com/vannyle)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-translations` + - [#7556](https://github.com/facebook/docusaurus/pull/7556) feat: add admonition type title translations ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-types`, `docusaurus-utils`, `docusaurus` + - [#7386](https://github.com/facebook/docusaurus/pull/7386) feat(core): allow customizing the i18n directory path ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-live-codeblock` + - [#7514](https://github.com/facebook/docusaurus/pull/7514) feat(live-codeblock): add support for noInline to interactive code blocks ([@jpdriver](https://github.com/jpdriver)) +- `docusaurus-plugin-content-docs` + - [#7461](https://github.com/facebook/docusaurus/pull/7461) feat(content-docs): last_update front matter ([@dpang314](https://github.com/dpang314)) + +#### :bug: Bug Fix + +- `docusaurus-theme-classic` + - [#7727](https://github.com/facebook/docusaurus/pull/7727) fix(theme): show blog post edit link even when no tag & not truncated ([@anaclumos](https://github.com/anaclumos)) + - [#7659](https://github.com/facebook/docusaurus/pull/7659) fix(theme-classic): expose empty string alt text in navbar logos ([@BenDMyers](https://github.com/BenDMyers)) + - [#7595](https://github.com/facebook/docusaurus/pull/7595) fix(content-pages): add article wrapper around MDXContent ([@matkoch](https://github.com/matkoch)) +- `docusaurus-theme-translations` + - [#7694](https://github.com/facebook/docusaurus/pull/7694) fix(theme-translations): typo in vi locale ([@saosangmo](https://github.com/saosangmo)) +- `docusaurus-plugin-content-docs` + - [#7638](https://github.com/facebook/docusaurus/pull/7638) fix(docs): forward doc frontMatter.sidebar_custom_props to linking sidebar category ([@slorber](https://github.com/slorber)) + - [#7634](https://github.com/facebook/docusaurus/pull/7634) fix(content-docs): allow translating doc labels in sidebars.js ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-utils` + - [#7604](https://github.com/facebook/docusaurus/pull/7604) fix(utils): allow any non-boundary characters in Markdown heading ID ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-cssnano-preset` + - [#7593](https://github.com/facebook/docusaurus/pull/7593) fix(cssnano-preset): disable z-index minification ([@dpang314](https://github.com/dpang314)) +- `docusaurus-theme-common` + - [#7551](https://github.com/facebook/docusaurus/pull/7551) fix(theme-classic): code block wrap mode should allow wrapping in the middle of a word ([@slorber](https://github.com/slorber)) + - [#7485](https://github.com/facebook/docusaurus/pull/7485) fix(theme-classic): inconsistent code block wrapping ([@dpang314](https://github.com/dpang314)) +- `docusaurus-mdx-loader`, `docusaurus-module-type-aliases`, `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-classic`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-types`, `docusaurus-utils-common`, `docusaurus-utils` + - [#7521](https://github.com/facebook/docusaurus/pull/7521) fix: make type-checking work in Yarn PnP ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :nail_care: Polish + +- `docusaurus-theme-translations` + - [#7696](https://github.com/facebook/docusaurus/pull/7696) fix(theme-translations): improve grammar of zh translation ([@AkagiYui](https://github.com/AkagiYui)) + - [#7691](https://github.com/facebook/docusaurus/pull/7691) chore(theme-translations): complete vi translations ([@datlechin](https://github.com/datlechin)) + - [#7683](https://github.com/facebook/docusaurus/pull/7683) chore(theme-translations): complete ar translations ([@Altomy](https://github.com/Altomy)) + - [#7633](https://github.com/facebook/docusaurus/pull/7633) chore(theme-translations): complete ko translations ([@HyunseungLee-Travis](https://github.com/HyunseungLee-Travis)) +- `docusaurus` + - [#7702](https://github.com/facebook/docusaurus/pull/7702) feat(deploy): copy local git config to tmp repo ([@ghostsquad](https://github.com/ghostsquad)) + - [#7600](https://github.com/facebook/docusaurus/pull/7600) fix: force refresh on chunk preload error ([@yangshun](https://github.com/yangshun)) +- `docusaurus-plugin-content-docs` + - [#7673](https://github.com/facebook/docusaurus/pull/7673) fix(content-docs): format last update date as "Jun 19, 2020" ([@sigwinch28](https://github.com/sigwinch28)) +- `docusaurus-theme-common`, `docusaurus-theme-search-algolia` + - [#7671](https://github.com/facebook/docusaurus/pull/7671) refactor(theme-common): rename useDynamicCallback to useEvent ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-common` + - [#7648](https://github.com/facebook/docusaurus/pull/7648) fix(theme-common): make useShallowMemoObject key-order-insensitive ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#7639](https://github.com/facebook/docusaurus/pull/7639) chore(create): update the facebook template with current assets ([@zpao](https://github.com/zpao)) + - [#7520](https://github.com/facebook/docusaurus/pull/7520) feat: add engines field to templates' package.json ([@johnnyreilly](https://github.com/johnnyreilly)) +- `docusaurus-mdx-loader`, `docusaurus-migrate`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-pwa`, `docusaurus-theme-classic`, `docusaurus` + - [#7579](https://github.com/facebook/docusaurus/pull/7579) refactor(pwa): simplify registerSW code, fix ESLint errors ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-google-analytics`, `docusaurus-plugin-google-gtag` + - [#7545](https://github.com/facebook/docusaurus/pull/7545) feat(analytics): allow query/hash changes to be sent to GA ([@lanegoolsby](https://github.com/lanegoolsby)) + +#### :memo: Documentation + +- Other + - [#7739](https://github.com/facebook/docusaurus/pull/7739) docs: swizzle react-live with eject ([@SheetJSDev](https://github.com/SheetJSDev)) + - [#7723](https://github.com/facebook/docusaurus/pull/7723) docs: add GitHub pages deployment troubleshooting guide ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7705](https://github.com/facebook/docusaurus/pull/7705) docs: mention MDXContent ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7675](https://github.com/facebook/docusaurus/pull/7675) docs: add docusaurus-openapi-docs to resources ([@sserrata](https://github.com/sserrata)) + - [#7677](https://github.com/facebook/docusaurus/pull/7677) docs: add more info on github cross repo deployment ([@bcabanes](https://github.com/bcabanes)) + - [#7563](https://github.com/facebook/docusaurus/pull/7563) docs: add awesome-docusaurus resource ([@webbertakken](https://github.com/webbertakken)) + - [#7665](https://github.com/facebook/docusaurus/pull/7665) docs: add link from every category index page to the guide page ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7519](https://github.com/facebook/docusaurus/pull/7519) docs: multiple documentation elaborations ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7518](https://github.com/facebook/docusaurus/pull/7518) docs: remove useless front matter ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7512](https://github.com/facebook/docusaurus/pull/7512) docs: update Kent C. Dodds Twitter avatar ([@DharsanB](https://github.com/DharsanB)) +- `create-docusaurus` + - [#7611](https://github.com/facebook/docusaurus/pull/7611) docs: advise using Node 18 in deployment ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7582](https://github.com/facebook/docusaurus/pull/7582) docs: make localhost links clickable ([@dht](https://github.com/dht)) +- `docusaurus-plugin-client-redirects` + - [#7607](https://github.com/facebook/docusaurus/pull/7607) refactor(client-redirects): elaborate documentation, minor refactor ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :wrench: Maintenance + +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#7676](https://github.com/facebook/docusaurus/pull/7676) refactor(theme): move LayoutProviders to Layout/Provider; composeProviders util ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#7674](https://github.com/facebook/docusaurus/pull/7674) chore: prevent importing theme components with relative paths ([@slorber](https://github.com/slorber)) + - [#7664](https://github.com/facebook/docusaurus/pull/7664) chore: upgrade Infima to alpha.40 ([@slorber](https://github.com/slorber)) +- Other + - [#7663](https://github.com/facebook/docusaurus/pull/7663) misc: share .vscode/extensions.json ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus` + - [#7583](https://github.com/facebook/docusaurus/pull/7583) refactor(cli): make the CLI an even thinner wrapper around command functions ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#7547](https://github.com/facebook/docusaurus/pull/7547) chore: update static-site-generator-webpack-plugin ([@slorber](https://github.com/slorber)) +- `create-docusaurus`, `docusaurus-cssnano-preset`, `docusaurus-logger`, `docusaurus-mdx-loader`, `docusaurus-migrate`, `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-classic`, `docusaurus-remark-plugin-npm2yarn`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia`, `docusaurus-theme-translations`, `docusaurus-types`, `docusaurus-utils-common`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus`, `eslint-plugin`, `lqip-loader`, `stylelint-copyright` + - [#7586](https://github.com/facebook/docusaurus/pull/7586) chore: upgrade to TS 4.7, compile with NodeNext ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### Committers: 51 + +- 7Wate ([@7Wate](https://github.com/7Wate)) +- Ahmed Altomy ([@Altomy](https://github.com/Altomy)) +- Alexander Nestorov ([@alexandernst](https://github.com/alexandernst)) +- Alexey Pyltsyn ([@lex111](https://github.com/lex111)) +- Ben Myers ([@BenDMyers](https://github.com/BenDMyers)) +- Benjamin Cabanes ([@bcabanes](https://github.com/bcabanes)) +- Boulet ([@Boulet-](https://github.com/Boulet-)) +- Charles Ancheta ([@cbebe](https://github.com/cbebe)) +- Clemie McCartney ([@clemiee](https://github.com/clemiee)) +- DOLLE ([@JeremyDolle](https://github.com/JeremyDolle)) +- Dharsan B ([@DharsanB](https://github.com/DharsanB)) +- Diego França ([@difranca](https://github.com/difranca)) +- Dima Grossman ([@scopsy](https://github.com/scopsy)) +- Dzung Do ([@saosangmo](https://github.com/saosangmo)) +- Flávio Silva ([@201flaviosilva](https://github.com/201flaviosilva)) +- Forresst ([@forresst](https://github.com/forresst)) +- Huy Nguyen ([@Smilefounder](https://github.com/Smilefounder)) +- Hyunseung Lee ([@HyunseungLee-Travis](https://github.com/HyunseungLee-Travis)) +- JP ([@jpdriver](https://github.com/jpdriver)) +- Joe Harrison ([@sigwinch28](https://github.com/sigwinch28)) +- John Reilly ([@johnnyreilly](https://github.com/johnnyreilly)) +- Johnie Hjelm ([@johnie](https://github.com/johnie)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Joshua Schmitt ([@jqshuv](https://github.com/jqshuv)) +- Kürşat Şimşek ([@kursatsmsek](https://github.com/kursatsmsek)) +- Lane Goolsby ([@lanegoolsby](https://github.com/lanegoolsby)) +- Le Thi Van ([@vannyle](https://github.com/vannyle)) +- Matthias Koch ([@matkoch](https://github.com/matkoch)) +- Ngô Quốc Đạt ([@datlechin](https://github.com/datlechin)) +- Paul O’Shannessy ([@zpao](https://github.com/zpao)) +- Redcamel ([@redcamel](https://github.com/redcamel)) +- Rein van Haaren ([@reinvanhaaren](https://github.com/reinvanhaaren)) +- Rudra Sen ([@RudraSen2](https://github.com/RudraSen2)) +- Steven Serrata ([@sserrata](https://github.com/sserrata)) +- Sunghyun Cho ([@anaclumos](https://github.com/anaclumos)) +- Szilárd Dóró ([@szilarddoro](https://github.com/szilarddoro)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- Tom Mrazauskas ([@mrazauskas](https://github.com/mrazauskas)) +- Webber Takken ([@webbertakken](https://github.com/webbertakken)) +- Wes McNamee ([@ghostsquad](https://github.com/ghostsquad)) +- Yangshun Tay ([@yangshun](https://github.com/yangshun)) +- [@SheetJSDev](https://github.com/SheetJSDev) +- [@alewolf](https://github.com/alewolf) +- [@dpang314](https://github.com/dpang314) +- dht ([@dht](https://github.com/dht)) +- emattia ([@emattia](https://github.com/emattia)) +- pincman ([@pincman](https://github.com/pincman)) +- sado ([@sado0823](https://github.com/sado0823)) +- 凱恩 Kane ([@Gary50613](https://github.com/Gary50613)) +- 李小雨 ([@metal-young](https://github.com/metal-young)) +- 赤城结衣 ([@AkagiYui](https://github.com/AkagiYui)) + ## 2.0.0-beta.21 (2022-05-27) #### :boom: Breaking Change diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index fe86a0cbfacd..352c66b6ab98 100644 --- a/admin/new.docusaurus.io/package.json +++ b/admin/new.docusaurus.io/package.json @@ -1,6 +1,6 @@ { "name": "new.docusaurus.io", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "private": true, "scripts": { "start": "npx --package netlify-cli netlify dev" diff --git a/lerna.json b/lerna.json index b1fa19591185..b5de421b40f1 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "npmClient": "yarn", "useWorkspaces": true, "changelog": { diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index 9984e76be577..5db84674302c 100755 --- a/packages/create-docusaurus/package.json +++ b/packages/create-docusaurus/package.json @@ -1,6 +1,6 @@ { "name": "create-docusaurus", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Create Docusaurus apps easily.", "type": "module", "repository": { @@ -22,8 +22,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "commander": "^5.1.0", "fs-extra": "^10.1.0", "lodash": "^4.17.21", diff --git a/packages/create-docusaurus/templates/classic-typescript/package.json b/packages/create-docusaurus/templates/classic-typescript/package.json index cc48db6679f5..dcc98c0ea725 100644 --- a/packages/create-docusaurus/templates/classic-typescript/package.json +++ b/packages/create-docusaurus/templates/classic-typescript/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-typescript-template", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/preset-classic": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/preset-classic": "2.0.0-beta.22", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.0", "prism-react-renderer": "^1.3.5", @@ -24,7 +24,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", "@tsconfig/docusaurus": "^1.0.5", "typescript": "^4.7.4" }, diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index 046b6d94a6b8..bf6eeedebc77 100644 --- a/packages/create-docusaurus/templates/classic/package.json +++ b/packages/create-docusaurus/templates/classic/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-template", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/preset-classic": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/preset-classic": "2.0.0-beta.22", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.0", "prism-react-renderer": "^1.3.5", @@ -23,7 +23,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21" + "@docusaurus/module-type-aliases": "2.0.0-beta.22" }, "browserslist": { "production": [ diff --git a/packages/create-docusaurus/templates/facebook/package.json b/packages/create-docusaurus/templates/facebook/package.json index ff7ab12cfefd..dfea248c957a 100644 --- a/packages/create-docusaurus/templates/facebook/package.json +++ b/packages/create-docusaurus/templates/facebook/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-facebook-template", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -18,8 +18,8 @@ "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\"" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/preset-classic": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/preset-classic": "2.0.0-beta.22", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.0", "react": "^17.0.2", diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index 1c7c52a584de..5b6dc7f8fb7b 100644 --- a/packages/docusaurus-cssnano-preset/package.json +++ b/packages/docusaurus-cssnano-preset/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/cssnano-preset", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Advanced cssnano preset for maximum optimization.", "main": "lib/index.js", "license": "MIT", diff --git a/packages/docusaurus-logger/package.json b/packages/docusaurus-logger/package.json index 6175c913da49..abff1073897e 100644 --- a/packages/docusaurus-logger/package.json +++ b/packages/docusaurus-logger/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/logger", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "An encapsulated logger for semantically formatting console messages.", "main": "./lib/index.js", "repository": { diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json index ca29eaa1b9e3..e5c6a6b95733 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -20,8 +20,8 @@ "dependencies": { "@babel/parser": "^7.18.6", "@babel/traverse": "^7.18.6", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "@mdx-js/mdx": "^1.6.22", "escape-html": "^1.0.3", "file-loader": "^6.2.0", @@ -37,14 +37,14 @@ "webpack": "^5.73.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/types": "2.0.0-beta.22", "@types/escape-html": "^1.0.2", "@types/mdast": "^3.0.10", "@types/stringify-object": "^3.3.1", "@types/unist": "^2.0.6", + "rehype-stringify": "^8.0.0", "remark": "^12.0.1", "remark-mdx": "^1.6.21", - "rehype-stringify": "^8.0.0", "remark-rehype": "^8.1.0", "to-vfile": "^6.1.0", "unist-builder": "^2.0.3", diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json index 363746829fdd..4c547c505558 100644 --- a/packages/docusaurus-migrate/package.json +++ b/packages/docusaurus-migrate/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/migrate", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "A CLI tool to migrate from older versions of Docusaurus.", "license": "MIT", "engines": { @@ -24,8 +24,8 @@ "dependencies": { "@babel/core": "^7.18.6", "@babel/preset-env": "^7.18.6", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "@mapbox/hast-util-to-jsx": "^2.0.0", "color": "^4.2.3", "commander": "^5.1.0", diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index 26d08a22247a..b49481ecad3c 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus module type aliases.", "types": "./src/index.d.ts", "publishConfig": { @@ -13,7 +13,7 @@ }, "dependencies": { "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/types": "2.0.0-beta.22", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index 57f3e138b7cb..b6ea2106398c 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-beta.21", + "version": "2.0.0-beta.22", "description": "Client redirects plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,18 +18,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "eta": "^1.12.3", "fs-extra": "^10.1.0", "lodash": "^4.17.21", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.21" + "@docusaurus/types": "2.0.0-beta.22" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json index 483a68d2e173..8fa6e3244f53 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-beta.21", + "version": "2.0.0-beta.22", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -18,13 +18,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/mdx-loader": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/mdx-loader": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "cheerio": "^1.0.0-rc.12", "feed": "^4.2.2", "fs-extra": "^10.1.0", diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index 28d79211769a..0f756297b9e4 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "sideEffects": false, @@ -34,13 +34,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/mdx-loader": "2.0.0-beta.21", - "@docusaurus/module-type-aliases": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/mdx-loader": "2.0.0-beta.22", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "@types/react-router-config": "^5.0.6", "combine-promises": "^1.1.0", "fs-extra": "^10.1.0", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index 1222fe058539..4bf7069048bc 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-beta.21", + "version": "2.0.0-beta.22", "description": "Pages plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-pages.d.ts", @@ -18,11 +18,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/mdx-loader": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/mdx-loader": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "fs-extra": "^10.1.0", "tslib": "^2.4.0", "webpack": "^5.73.0" diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index d9e1cb136ad8..834d802fba81 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-beta.21", + "version": "2.0.0-beta.22", "description": "Debug plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-debug.d.ts", @@ -20,9 +20,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "fs-extra": "^10.1.0", "react-json-view": "^1.21.3", "tslib": "^2.4.0" diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index e4247fa62587..c1e55437cac9 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-beta.21", + "version": "2.0.0-beta.22", "description": "Global analytics (analytics.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "tslib": "^2.4.0" }, "devDependencies": { diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index f00b672e394c..e1b67006d10c 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-beta.21", + "version": "2.0.0-beta.22", "description": "Global Site Tag (gtag.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "tslib": "^2.4.0" }, "devDependencies": { diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index acdd8d69bc69..f43806fb7006 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).", "main": "lib/index.js", "types": "src/plugin-ideal-image.d.ts", @@ -20,12 +20,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/lqip-loader": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/lqip-loader": "2.0.0-beta.22", "@docusaurus/responsive-loader": "^1.7.0", - "@docusaurus/theme-translations": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/theme-translations": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "@endiliey/react-ideal-image": "^0.0.11", "react-waypoint": "^10.3.0", "sharp": "^0.30.7", @@ -33,7 +33,7 @@ "webpack": "^5.73.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", "@docusaurus/types": "2.0.0-beta.21", "fs-extra": "^10.1.0" }, diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 99b962329802..4f43cc16cb15 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus Plugin to add PWA support.", "main": "lib/index.js", "types": "src/plugin-pwa.d.ts", @@ -22,12 +22,12 @@ "dependencies": { "@babel/core": "^7.18.6", "@babel/preset-env": "^7.18.6", - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-translations": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-translations": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "babel-loader": "^8.2.5", "clsx": "^1.2.0", "core-js": "^3.23.3", @@ -40,7 +40,7 @@ "workbox-window": "^6.5.3" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", "fs-extra": "^10.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index 2b9a9430eeae..23b65ea3476c 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-beta.21", + "version": "2.0.0-beta.22", "description": "Simple sitemap generation plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "fs-extra": "^10.1.0", "sitemap": "^7.1.1", "tslib": "^2.4.0" diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 7a1cccb25234..38580177c5ba 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-beta.21", + "version": "2.0.0-beta.22", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,18 +18,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/plugin-content-blog": "2.0.0-beta.21", - "@docusaurus/plugin-content-docs": "2.0.0-beta.21", - "@docusaurus/plugin-content-pages": "2.0.0-beta.21", - "@docusaurus/plugin-debug": "2.0.0-beta.21", - "@docusaurus/plugin-google-analytics": "2.0.0-beta.21", - "@docusaurus/plugin-google-gtag": "2.0.0-beta.21", - "@docusaurus/plugin-sitemap": "2.0.0-beta.21", - "@docusaurus/theme-classic": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-search-algolia": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21" + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/plugin-content-blog": "2.0.0-beta.22", + "@docusaurus/plugin-content-docs": "2.0.0-beta.22", + "@docusaurus/plugin-content-pages": "2.0.0-beta.22", + "@docusaurus/plugin-debug": "2.0.0-beta.22", + "@docusaurus/plugin-google-analytics": "2.0.0-beta.22", + "@docusaurus/plugin-google-gtag": "2.0.0-beta.22", + "@docusaurus/plugin-sitemap": "2.0.0-beta.22", + "@docusaurus/theme-classic": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-search-algolia": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json index 3f2ab9582005..e94aff7e42f4 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/package.json +++ b/packages/docusaurus-remark-plugin-npm2yarn/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/remark-plugin-npm2yarn", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Remark plugin for converting npm commands to Yarn commands as tabs.", "main": "lib/index.js", "publishConfig": { diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json index 7cfe647c423a..a2a36a0c8435 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-beta.21", + "version": "2.0.0-beta.22", "description": "Classic theme for Docusaurus", "main": "lib/index.js", "types": "src/theme-classic.d.ts", @@ -20,22 +20,22 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/mdx-loader": "2.0.0-beta.21", - "@docusaurus/module-type-aliases": "2.0.0-beta.21", - "@docusaurus/plugin-content-blog": "2.0.0-beta.21", - "@docusaurus/plugin-content-docs": "2.0.0-beta.21", - "@docusaurus/plugin-content-pages": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-translations": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/mdx-loader": "2.0.0-beta.22", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", + "@docusaurus/plugin-content-blog": "2.0.0-beta.22", + "@docusaurus/plugin-content-docs": "2.0.0-beta.22", + "@docusaurus/plugin-content-pages": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-translations": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.0", "copy-text-to-clipboard": "^3.0.1", - "infima": "0.2.0-alpha.40", + "infima": "0.2.0-alpha.41", "lodash": "^4.17.21", "nprogress": "^0.2.0", "postcss": "^8.4.14", diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index 12b53b56b1c7..f3695a24ff19 100644 --- a/packages/docusaurus-theme-common/package.json +++ b/packages/docusaurus-theme-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-common", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -30,12 +30,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/mdx-loader": "2.0.0-beta.21", - "@docusaurus/module-type-aliases": "2.0.0-beta.21", - "@docusaurus/plugin-content-blog": "2.0.0-beta.21", - "@docusaurus/plugin-content-docs": "2.0.0-beta.21", - "@docusaurus/plugin-content-pages": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/mdx-loader": "2.0.0-beta.22", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", + "@docusaurus/plugin-content-blog": "2.0.0-beta.22", + "@docusaurus/plugin-content-docs": "2.0.0-beta.22", + "@docusaurus/plugin-content-pages": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", @@ -46,8 +46,8 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", "fs-extra": "^10.1.0", "lodash": "^4.17.21" }, diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index d37c152227a9..0f29af5e5a27 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-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus live code block component.", "main": "lib/index.js", "types": "src/theme-live-codeblock.d.ts", @@ -23,10 +23,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-translations": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-translations": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "@philpl/buble": "^0.19.7", "clsx": "^1.2.0", "fs-extra": "^10.1.0", @@ -34,7 +34,7 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/types": "2.0.0-beta.22", "@types/buble": "^0.20.1" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index ae184b7fa3d5..844c8a8da14e 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-beta.21", + "version": "2.0.0-beta.22", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ @@ -34,13 +34,13 @@ }, "dependencies": { "@docsearch/react": "^3.1.1", - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/plugin-content-docs": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-translations": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/plugin-content-docs": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-translations": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "algoliasearch": "^4.13.1", "algoliasearch-helper": "^3.10.0", "clsx": "^1.2.0", @@ -51,7 +51,7 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21" + "@docusaurus/module-type-aliases": "2.0.0-beta.22" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index 3e4d47626f8b..bb47a90e0432 100644 --- a/packages/docusaurus-theme-translations/package.json +++ b/packages/docusaurus-theme-translations/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-translations", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Docusaurus theme translations.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -23,8 +23,8 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", "lodash": "^4.17.21" }, "engines": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index a029043b5181..d581f8efd2f5 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Common types for Docusaurus packages.", "types": "./src/index.d.ts", "publishConfig": { diff --git a/packages/docusaurus-utils-common/package.json b/packages/docusaurus-utils-common/package.json index 50ea22d1d835..c05c3764e077 100644 --- a/packages/docusaurus-utils-common/package.json +++ b/packages/docusaurus-utils-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-common", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Common (Node/Browser) utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index 7c98f611dda3..a22e52e10acb 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-beta.21", + "version": "2.0.0-beta.22", "description": "Node validation utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,8 +18,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", "joi": "^17.6.0", "js-yaml": "^4.1.0", "tslib": "^2.4.0" diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index f378e85e118c..b8af381827f0 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Node utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,7 +18,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", "@svgr/webpack": "^6.2.1", "file-loader": "^6.2.0", "fs-extra": "^10.1.0", @@ -38,7 +38,7 @@ "node": ">=16.14" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/types": "2.0.0-beta.22", "@types/dedent": "^0.7.0", "@types/github-slugger": "^1.3.0", "@types/micromatch": "^4.0.2", diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index f902ed4843ce..f0c494f09f80 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-beta.21", + "version": "2.0.0-beta.22", "license": "MIT", "publishConfig": { "access": "public" @@ -43,13 +43,13 @@ "@babel/runtime": "^7.18.6", "@babel/runtime-corejs3": "^7.18.6", "@babel/traverse": "^7.18.6", - "@docusaurus/cssnano-preset": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/mdx-loader": "2.0.0-beta.21", + "@docusaurus/cssnano-preset": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/mdx-loader": "2.0.0-beta.22", "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", - "@docusaurus/utils-validation": "2.0.0-beta.21", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", + "@docusaurus/utils-validation": "2.0.0-beta.22", "@slorber/static-site-generator-webpack-plugin": "^4.0.7", "@svgr/webpack": "^6.2.1", "autoprefixer": "^10.4.7", @@ -106,8 +106,8 @@ "webpackbar": "^5.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.21", - "@docusaurus/types": "2.0.0-beta.21", + "@docusaurus/module-type-aliases": "2.0.0-beta.22", + "@docusaurus/types": "2.0.0-beta.22", "@types/detect-port": "^1.3.2", "@types/react-dom": "^18.0.5", "@types/react-router-config": "^5.0.6", diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index 41c733b8843c..a2bd69d51119 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/eslint-plugin", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "ESLint plugin to enforce best Docusaurus practices.", "main": "lib/index.js", "keywords": [ diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index 3cab0c6f79e6..04dee1b565d5 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-beta.21", + "version": "2.0.0-beta.22", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { @@ -17,7 +17,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.21", + "@docusaurus/logger": "2.0.0-beta.22", "file-loader": "^6.2.0", "lodash": "^4.17.21", "sharp": "^0.30.7", diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index 18aa9afe6e48..b56492b0f72d 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "lib/index.js", "license": "MIT", diff --git a/website/package.json b/website/package.json index 4e12dcb0aa69..5b97d0b27926 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "2.0.0-beta.21", + "version": "2.0.0-beta.22", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -35,18 +35,18 @@ "dependencies": { "@crowdin/cli": "^3.7.8", "@crowdin/crowdin-api-client": "^1.18.2", - "@docusaurus/core": "2.0.0-beta.21", - "@docusaurus/logger": "2.0.0-beta.21", - "@docusaurus/plugin-client-redirects": "2.0.0-beta.21", - "@docusaurus/plugin-ideal-image": "2.0.0-beta.21", - "@docusaurus/plugin-pwa": "2.0.0-beta.21", - "@docusaurus/preset-classic": "2.0.0-beta.21", - "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.21", - "@docusaurus/theme-classic": "2.0.0-beta.21", - "@docusaurus/theme-common": "2.0.0-beta.21", - "@docusaurus/theme-live-codeblock": "2.0.0-beta.21", - "@docusaurus/utils": "2.0.0-beta.21", - "@docusaurus/utils-common": "2.0.0-beta.21", + "@docusaurus/core": "2.0.0-beta.22", + "@docusaurus/logger": "2.0.0-beta.22", + "@docusaurus/plugin-client-redirects": "2.0.0-beta.22", + "@docusaurus/plugin-ideal-image": "2.0.0-beta.22", + "@docusaurus/plugin-pwa": "2.0.0-beta.22", + "@docusaurus/preset-classic": "2.0.0-beta.22", + "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.22", + "@docusaurus/theme-classic": "2.0.0-beta.22", + "@docusaurus/theme-common": "2.0.0-beta.22", + "@docusaurus/theme-live-codeblock": "2.0.0-beta.22", + "@docusaurus/utils": "2.0.0-beta.22", + "@docusaurus/utils-common": "2.0.0-beta.22", "@popperjs/core": "^2.11.5", "@swc/core": "1.2.197", "clsx": "^1.2.0", @@ -80,7 +80,7 @@ ] }, "devDependencies": { - "@docusaurus/eslint-plugin": "2.0.0-beta.21", + "@docusaurus/eslint-plugin": "2.0.0-beta.22", "@tsconfig/docusaurus": "^1.0.5", "@types/jest": "^28.1.4", "cross-env": "^7.0.3", diff --git a/website/versioned_docs/version-2.0.0-beta.20/guides/docs/docs-create-doc.mdx b/website/versioned_docs/version-2.0.0-beta.20/guides/docs/docs-create-doc.mdx deleted file mode 100644 index f81121781d1d..000000000000 --- a/website/versioned_docs/version-2.0.0-beta.20/guides/docs/docs-create-doc.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -id: create-doc -title: Create a doc -description: Create a Markdown Document -slug: /create-doc ---- - -Create a Markdown file, `greeting.md`, and place it under the `docs` directory. - -```bash -website # root directory of your site -├── docs -│ └── greeting.md -├── src -│ └── pages -├── docusaurus.config.js -├── ... -``` - -At the top of the file, specify `id` and `title` in the front matter, so that Docusaurus will pick them up correctly when generating your site. - -```md ---- -id: greeting -title: Hello ---- - -## Hello from Docusaurus - -Are you ready to create the documentation site for your open source project? - -### Headers - -will show up on the table of contents on the upper right - -So that your users will know what this page is all about without scrolling down or even without reading too much. - -### Only h2 and h3 will be in the TOC by default. - -You can configure the TOC heading levels either per-document or in the theme configuration. - -The headers are well-spaced so that the hierarchy is clear. - -- lists will help you -- present the key points -- that you want your users to remember - - and you may nest them - - multiple times - -### Custom id headers {#custom-id} - -With `{#custom-id}` syntax you can set your own header id. -``` - -This will render in the browser as follows: - -```mdx-code-block -import BrowserWindow from '@site/src/components/BrowserWindow'; - - - -

Hello from Docusaurus

- -Are you ready to create the documentation site for your open source project? - -

Headers

- -will show up on the table of contents on the upper right - -So that your users will know what this page is all about without scrolling down or even without reading too much. - -

Only h2 and h3 will be in the TOC by default.

- -You can configure the TOC heading levels either per document or in the theme configuration. - -The headers are well-spaced so that the hierarchy is clear. - -- lists will help you -- present the key points -- that you want your users to remember - - and you may nest them - - multiple times - -

Custom id headers

- -With {#custom-id} syntax you can set your own header id. - -
-``` - -:::note - -All files prefixed with an underscore (`_`) under the `docs` directory are treated as "partial" pages and will be ignored by default. - -Read more about [importing partial pages](../markdown-features/markdown-features-react.mdx#importing-markdown). - -::: - -## Doc tags {#doc-tags} - -Optionally, you can add tags to your doc pages, which introduces another dimension of categorization in addition to the [docs sidebar](./sidebar/index.md). Tags are passed in the front matter as a list of labels: - -```md "your-doc-page.md" ---- -id: doc-with-tags -title: A doc with tags -tags: - - Demo - - Getting started ---- -``` - -:::tip - -Tags can also be declared with `tags: [Demo, Getting started]`. - -Read more about all the possible [Yaml array syntaxes](https://www.w3schools.io/file/yaml-arrays/). - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/architecture.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/architecture.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/architecture.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/architecture.md diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/client.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/client.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/client.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/client.md diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/index.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/index.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/index.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/index.md diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/plugins.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/plugins.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/plugins.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/plugins.md diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/routing.md similarity index 99% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/routing.md index 82c85b7aae12..9ee8294b1b1a 100644 --- a/website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md +++ b/website/versioned_docs/version-2.0.0-beta.22/advanced/routing.md @@ -81,7 +81,7 @@ When writing links in Markdown, you could either mean a _file path_, or a _URL p - If the path has an `.md(x)` extension, Docusaurus would try to resolve that Markdown file to a URL, and replace the file path with a URL path. - If the path has any other extension, Docusaurus would treat it as [an asset](../guides/markdown-features/markdown-features-assets.mdx) and bundle it. -The following directory structure may help you visualize this file -> URL mapping. Assume that there's no slug customization in any page. +The following directory structure may help you visualize this file → URL mapping. Assume that there's no slug customization in any page.
diff --git a/website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md b/website/versioned_docs/version-2.0.0-beta.22/advanced/ssg.md similarity index 94% rename from website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md rename to website/versioned_docs/version-2.0.0-beta.22/advanced/ssg.md index 0a394f9179b4..09fb981e6dfc 100644 --- a/website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md +++ b/website/versioned_docs/version-2.0.0-beta.22/advanced/ssg.md @@ -8,12 +8,14 @@ description: Docusaurus statically renders your React code into HTML, allowing f In [architecture](architecture.md), we mentioned that the theme is run in Webpack. But beware: that doesn't mean it always has access to browser globals! The theme is built twice: - During **server-side rendering**, the theme is compiled in a sandbox called [React DOM Server](https://reactjs.org/docs/react-dom-server.html). You can see this as a "headless browser", where there is no `window` or `document`, only React. SSR produces static HTML pages. -- During **client-side rendering**, the theme is compiled with standard React DOM, and has access to browser variables. CSR produces dynamic JavaScript. +- During **client-side rendering**, the theme is compiled to JavaScript that gets eventually executed in the browser, so it has access to browser variables. :::info SSR or SSG? _Server-side rendering_ and _static site generation_ can be different concepts, but we use them interchangeably. +Strictly speaking, Docusaurus is a static site generator, because there's no server-side runtime—we statically render to HTML files that are deployed on a CDN, instead of dynamically pre-rendering on each request. This differs from the working model of [Next.js](https://nextjs.org/). + ::: Therefore, while you probably know not to access Node globals like `process` ([or can we?](#node-env)) or the `'fs'` module, you can't freely access browser globals either. @@ -34,9 +36,10 @@ ReferenceError: window is not defined This is because during server-side rendering, the Docusaurus app isn't actually run in browser, and it doesn't know what `window` is. +```mdx-code-block
- What about process.env.NODE_ENV? +``` One exception to the "no Node globals" rule is `process.env.NODE_ENV`. In fact, you can use it in React, because Webpack injects this variable as a global: @@ -56,8 +59,10 @@ During Webpack build, the `process.env.NODE_ENV` will be replaced with the value import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +```mdx-code-block +``` ```diff import React from 'react'; @@ -72,8 +77,10 @@ export default function expensiveComp() { } ``` +```mdx-code-block +``` ```diff import React from 'react'; @@ -88,9 +95,11 @@ export default function expensiveComp() { } ``` +```mdx-code-block
+``` ## Understanding SSR {#understanding-ssr} diff --git a/website/versioned_docs/version-2.0.0-beta.20/api/docusaurus.config.js.md b/website/versioned_docs/version-2.0.0-beta.22/api/docusaurus.config.js.md similarity index 89% rename from website/versioned_docs/version-2.0.0-beta.20/api/docusaurus.config.js.md rename to website/versioned_docs/version-2.0.0-beta.22/api/docusaurus.config.js.md index 488fd728c38c..6aea4f53b140 100644 --- a/website/versioned_docs/version-2.0.0-beta.20/api/docusaurus.config.js.md +++ b/website/versioned_docs/version-2.0.0-beta.22/api/docusaurus.config.js.md @@ -1,6 +1,5 @@ --- sidebar_position: 0 -id: docusaurus.config.js description: API reference for Docusaurus configuration file. slug: /api/docusaurus-config --- @@ -64,7 +63,7 @@ module.exports = { - 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. +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 = { @@ -76,7 +75,7 @@ module.exports = { - Type: `string` -Base URL for your site. Can be considered as the path after the host. For example, `/metro/` is the base URL 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. Always has both leading and trailing slash. +Base URL for your site. Can be considered as the path after the host. For example, `/metro/` is the base URL 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. Always has both leading and trailing slash. ```js title="docusaurus.config.js" module.exports = { @@ -130,19 +129,22 @@ Example: module.exports = { i18n: { defaultLocale: 'en', - locales: ['en', 'fr'], + locales: ['en', 'fa'], + path: 'i18n', localeConfigs: { en: { label: 'English', direction: 'ltr', htmlLang: 'en-US', calendar: 'gregory', + path: 'en', }, fa: { label: 'فارسی', direction: 'rtl', htmlLang: 'fa-IR', calendar: 'persian', + path: 'fa', }, }, }, @@ -151,11 +153,13 @@ module.exports = { - `defaultLocale`: The locale that (1) does not have its name in the base URL (2) gets started with `docusaurus start` without `--locale` option (3) will be used for the `` tag - `locales`: List of locales deployed on your site. Must contain `defaultLocale`. +- `path`: Root folder which all locale folders are relative to. Can be absolute or relative to the config file. Defaults to `i18n`. - `localeConfigs`: Individual options for each locale. - `label`: The label displayed for this locale in the locales dropdown. - - `direction`: `ltr` (default) or `rtl` (for [right-to-left languages](https://developer.mozilla.org/en-US/docs/Glossary/rtl) like Arabic, Hebrew, etc.). Used to select the locale's CSS and html meta attribute. + - `direction`: `ltr` (default) or `rtl` (for [right-to-left languages](https://developer.mozilla.org/en-US/docs/Glossary/rtl) like Farsi, Arabic, Hebrew, etc.). Used to select the locale's CSS and HTML meta attribute. - `htmlLang`: BCP 47 language tag to use in `` and in `` - `calendar`: the [calendar](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar) used to calculate the date era. Note that it doesn't control the actual string displayed: `MM/DD/YYYY` and `DD/MM/YYYY` are both `gregory`. To choose the format (`DD/MM/YYYY` or `MM/DD/YYYY`), set your locale name to `en-GB` or `en-US` (`en` means `en-US`). + - `path`: Root folder that all plugin localization folders of this locale are relative to. Will be resolved against `i18n.path`. Defaults to the locale's name. Note: this has no effect on the locale's `baseUrl`—customization of base URL is a work-in-progress. ### `noIndex` {#noIndex} @@ -173,7 +177,7 @@ module.exports = { ### `onBrokenLinks` {#onBrokenLinks} -- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'` +- Type: `'ignore' | 'log' | 'warn' | 'throw'` The behavior of Docusaurus when it detects any broken link. @@ -187,15 +191,15 @@ The broken links detection is only available for a production build (`docusaurus ### `onBrokenMarkdownLinks` {#onBrokenMarkdownLinks} -- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'` +- Type: `'ignore' | 'log' | 'warn' | 'throw'` -The behavior of Docusaurus when it detects any broken markdown link. +The behavior of Docusaurus when it detects any broken Markdown link. -By default, it prints a warning, to let you know about your broken markdown link, but you can change this security if needed. +By default, it prints a warning, to let you know about your broken Markdown link, but you can change this security if needed. ### `onDuplicateRoutes` {#onDuplicateRoutes} -- Type: `'ignore' | 'log' | 'warn' | 'error' | 'throw'` +- Type: `'ignore' | 'log' | 'warn' | 'throw'` The behavior of Docusaurus when it detects any [duplicate routes](/guides/creating-pages.md#duplicate-routes). @@ -330,8 +334,9 @@ module.exports = { // ... other links ], logo: { - alt: 'Facebook Open Source Logo', - src: 'https://docusaurus.io/img/oss_logo.png', + alt: 'Meta Open Source Logo', + src: 'img/meta_oss_logo.png', + href: 'https://opensource.fb.com', width: 160, height: 51, }, @@ -426,7 +431,7 @@ module.exports = { ### `scripts` {#scripts} -An array of scripts to load. The values can be either strings or plain objects of attribute-value maps. The `