From d6cff8c75453b591bc654d8b2ebd148c2e69dd48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Wed, 26 Jan 2022 19:28:16 +0100 Subject: [PATCH] chore(v2): prepare v2.0.0-beta.15 release (#6473) --- CHANGELOG.md | 314 +++++++ admin/new.docusaurus.io/package.json | 2 +- lerna.json | 2 +- packages/create-docusaurus/package.json | 4 +- .../templates/classic-typescript/package.json | 8 +- .../templates/classic/package.json | 6 +- .../templates/facebook/package.json | 6 +- .../docusaurus-cssnano-preset/package.json | 2 +- packages/docusaurus-logger/package.json | 2 +- packages/docusaurus-mdx-loader/package.json | 8 +- packages/docusaurus-migrate/package.json | 4 +- .../package.json | 4 +- .../package.json | 14 +- .../package.json | 16 +- .../package.json | 16 +- .../package.json | 12 +- packages/docusaurus-plugin-debug/package.json | 8 +- .../package.json | 8 +- .../package.json | 8 +- .../package.json | 14 +- packages/docusaurus-plugin-pwa/package.json | 14 +- .../docusaurus-plugin-sitemap/package.json | 12 +- .../docusaurus-preset-classic/package.json | 24 +- .../package.json | 2 +- .../docusaurus-theme-classic/package.json | 24 +- packages/docusaurus-theme-common/package.json | 14 +- .../package.json | 12 +- .../package.json | 16 +- .../package.json | 6 +- packages/docusaurus-types/package.json | 2 +- packages/docusaurus-utils-common/package.json | 4 +- .../docusaurus-utils-validation/package.json | 6 +- packages/docusaurus-utils/package.json | 6 +- packages/docusaurus/package.json | 18 +- packages/lqip-loader/package.json | 2 +- packages/stylelint-copyright/package.json | 2 +- website/package.json | 20 +- .../version-2.0.0-beta.13/advanced/routing.md | 17 - .../api/plugins/plugin-client-redirects.md | 130 --- .../api/plugins/plugin-debug.md | 40 - .../api/plugins/plugin-google-analytics.md | 94 -- .../api/plugins/plugin-google-gtag.md | 100 --- .../api/plugins/plugin-ideal-image.md | 53 -- .../api/plugins/plugin-sitemap.md | 37 - .../guides/docs/docs-introduction.md | 86 -- .../guides/docs/sidebar.md | 809 ------------------ .../guides/docs/versioning.md | 216 ----- .../markdown-features-admonitions.mdx | 123 --- .../markdown-features-math-equations.mdx | 116 --- .../markdown-features-react.mdx | 218 ----- .../i18n/i18n-tutorial.md | 336 -------- .../version-2.0.0-beta.13/presets.md | 137 --- .../version-2.0.0-beta.13/static-assets.md | 71 -- .../version-2.0.0-beta.13/using-plugins.md | 209 ----- .../version-2.0.0-beta.13/using-themes.md | 247 ------ .../_partials/swizzleWarning.mdx | 0 .../advanced/architecture.md | 28 + .../version-2.0.0-beta.15/advanced/index.md | 12 + .../version-2.0.0-beta.15/advanced/plugins.md | 129 +++ .../version-2.0.0-beta.15/advanced/routing.md | 277 ++++++ .../version-2.0.0-beta.15/advanced/ssg.md | 206 +++++ .../advanced/swizzling.md | 195 +++++ .../api/docusaurus.config.js.md | 81 +- .../api/plugin-methods/README.md | 8 +- .../api/plugin-methods/_category_.yml | 0 .../plugin-methods/extend-infrastructure.md | 30 +- .../api/plugin-methods/i18n-lifecycles.md | 4 +- .../api/plugin-methods/lifecycle-apis.md | 41 +- .../api/plugin-methods/static-methods.md | 22 +- .../api/plugins/_category_.yml | 0 .../api/plugins/overview.md | 0 .../api/plugins/plugin-client-redirects.md | 98 +++ .../api/plugins/plugin-content-blog.md | 97 +-- .../api/plugins/plugin-content-docs.md | 110 +-- .../api/plugins/plugin-content-pages.md | 65 +- .../api/plugins/plugin-debug.md | 102 +++ .../api/plugins/plugin-google-analytics.md | 63 ++ .../api/plugins/plugin-google-gtag.md | 69 ++ .../api/plugins/plugin-ideal-image.md | 79 ++ .../api/plugins/plugin-pwa.md | 0 .../api/plugins/plugin-sitemap.md | 72 ++ .../api/themes/_category_.yml | 0 .../api/themes/overview.md | 0 .../api/themes/theme-classic.md | 0 .../api/themes/theme-configuration.md | 130 ++- .../api/themes/theme-live-codeblock.md | 2 +- .../api/themes/theme-search-algolia.md | 2 +- .../docusaurus-asset-example-banner.png | Bin .../assets/docusaurus-asset-example.docx | Bin .../assets/docusaurus-asset-example.xyz | Bin .../blog.mdx | 122 ++- .../browser-support.md | 60 +- .../cli.md | 10 +- .../configuration.md | 63 +- .../deployment.mdx | 52 +- .../docusaurus-core.md | 116 ++- .../guides/creating-pages.md | 43 +- .../guides/docs/docs-create-doc.mdx | 18 +- .../guides/docs/docs-introduction.md | 163 ++++ .../guides/docs/docs-markdown-features.mdx | 6 +- .../guides/docs/docs-multi-instance.mdx | 10 +- .../guides/docs/sidebar/autogenerated.md | 471 ++++++++++ .../guides/docs/sidebar/index.md | 179 ++++ .../guides/docs/sidebar/items.md | 452 ++++++++++ .../guides/docs/sidebar/multiple-sidebars.md | 142 +++ .../guides/docs/versioning.md | 280 ++++++ .../_markdown-partial-example.mdx | 0 .../markdown-features-admonitions.mdx | 199 +++++ .../markdown-features-assets.mdx | 71 +- .../markdown-features-code-blocks.mdx | 295 +++++-- .../markdown-features-head-metadata.mdx | 8 +- .../markdown-features-headings.mdx | 8 +- .../markdown-features-inline-toc.mdx | 6 +- .../markdown-features-intro.mdx | 22 +- .../markdown-features-math-equations.mdx | 193 +++++ .../markdown-features-plugins.mdx | 54 +- .../markdown-features-react.mdx | 465 ++++++++++ .../markdown-features-react.module.css | 17 + .../markdown-features-tabs-styles.module.css | 30 + .../markdown-features-tabs.mdx | 89 +- .../guides/whats-next.md | 21 + .../i18n/i18n-crowdin.mdx | 67 +- .../i18n/i18n-git.md | 18 +- .../i18n/i18n-introduction.md | 64 +- .../i18n/i18n-tutorial.md | 457 ++++++++++ .../installation.md | 35 +- .../introduction.md | 68 +- .../migration/migration-automated.md | 0 .../migration/migration-manual.md | 68 +- .../migration/migration-overview.md | 2 +- .../migration/migration-translated-sites.md | 6 +- .../migration/migration-versioned-sites.md | 10 +- .../playground.mdx | 0 .../search.md | 76 +- .../seo.md | 22 +- .../version-2.0.0-beta.15/static-assets.md | 108 +++ .../styling-layout.md | 159 ++-- .../typescript-support.md | 24 +- .../version-2.0.0-beta.15/using-plugins.md | 320 +++++++ ...on => version-2.0.0-beta.15-sidebars.json} | 36 +- website/versions.json | 5 +- website/versionsArchived.json | 1 + 142 files changed, 6704 insertions(+), 4110 deletions(-) delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/advanced/routing.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-client-redirects.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-debug.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-analytics.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-gtag.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-ideal-image.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-sitemap.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/docs/docs-introduction.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/docs/sidebar.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/docs/versioning.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-admonitions.mdx delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-math-equations.mdx delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-react.mdx delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/i18n/i18n-tutorial.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/presets.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/static-assets.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/using-plugins.md delete mode 100644 website/versioned_docs/version-2.0.0-beta.13/using-themes.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/_partials/swizzleWarning.mdx (100%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/architecture.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/index.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/plugins.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/routing.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/ssg.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/advanced/swizzling.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/docusaurus.config.js.md (86%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/README.md (93%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/_category_.yml (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/extend-infrastructure.md (71%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/i18n-lifecycles.md (94%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/lifecycle-apis.md (88%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugin-methods/static-methods.md (80%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/_category_.yml (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/overview.md (100%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-client-redirects.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/plugin-content-blog.md (81%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/plugin-content-docs.md (80%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/plugin-content-pages.md (64%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-debug.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-google-analytics.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-google-gtag.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-ideal-image.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/plugins/plugin-pwa.md (100%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/api/plugins/plugin-sitemap.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/_category_.yml (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/overview.md (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/theme-classic.md (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/theme-configuration.md (87%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/theme-live-codeblock.md (95%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/api/themes/theme-search-algolia.md (91%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/assets/docusaurus-asset-example-banner.png (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/assets/docusaurus-asset-example.docx (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/assets/docusaurus-asset-example.xyz (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/blog.mdx (77%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/browser-support.md (52%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/cli.md (95%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/configuration.md (61%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/deployment.mdx (91%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/docusaurus-core.md (82%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/creating-pages.md (72%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/docs/docs-create-doc.mdx (87%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/docs-introduction.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/docs/docs-markdown-features.mdx (83%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/docs/docs-multi-instance.mdx (92%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/sidebar/autogenerated.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/sidebar/index.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/sidebar/items.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/sidebar/multiple-sidebars.md create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/docs/versioning.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/_markdown-partial-example.mdx (100%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/markdown-features/markdown-features-admonitions.mdx rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-assets.mdx (66%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-code-blocks.mdx (67%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-head-metadata.mdx (81%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-headings.mdx (82%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-inline-toc.mdx (91%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-intro.mdx (79%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/markdown-features/markdown-features-math-equations.mdx rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-plugins.mdx (76%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/markdown-features/markdown-features-react.mdx create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/markdown-features/markdown-features-react.module.css create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/markdown-features/markdown-features-tabs-styles.module.css rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/guides/markdown-features/markdown-features-tabs.mdx (70%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/guides/whats-next.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/i18n/i18n-crowdin.mdx (87%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/i18n/i18n-git.md (90%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/i18n/i18n-introduction.md (66%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/i18n/i18n-tutorial.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/installation.md (76%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/introduction.md (57%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/migration/migration-automated.md (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/migration/migration-manual.md (93%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/migration/migration-overview.md (99%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/migration/migration-translated-sites.md (96%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/migration/migration-versioned-sites.md (92%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/playground.mdx (100%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/search.md (73%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/seo.md (84%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/static-assets.md rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/styling-layout.md (55%) rename website/versioned_docs/{version-2.0.0-beta.13 => version-2.0.0-beta.15}/typescript-support.md (83%) create mode 100644 website/versioned_docs/version-2.0.0-beta.15/using-plugins.md rename website/versioned_sidebars/{version-2.0.0-beta.13-sidebars.json => version-2.0.0-beta.15-sidebars.json} (78%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1dc67ac55b..4f104ed1d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,319 @@ # Docusaurus 2 Changelog +## 2.0.0-beta.15 (2022-01-26) + +#### :rocket: New Feature + +- `docusaurus-plugin-content-docs` + - [#6451](https://github.com/facebook/docusaurus/pull/6451) feat(content-docs): expose isCategoryIndex matcher to customize conventions ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#5782](https://github.com/facebook/docusaurus/pull/5782) feat(content-docs): displayed_sidebar front matter ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#6466](https://github.com/facebook/docusaurus/pull/6466) feat(theme-classic): add stable class for DocSidebarContainer ([@homotechsual](https://github.com/homotechsual)) + - [#3811](https://github.com/facebook/docusaurus/pull/3811) feat(theme-classic): auto-collapse sibling categories in doc sidebar ([@josephriosIO](https://github.com/josephriosIO)) + - [#6216](https://github.com/facebook/docusaurus/pull/6216) feat(theme-classic): usable CodeBlock outside markdown ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic` + - [#6416](https://github.com/facebook/docusaurus/pull/6416) feat(content-blog): allow authors list to contain images only ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-blog` + - [#6415](https://github.com/facebook/docusaurus/pull/6415) feat(content-blog): allow disabling generating archive ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6245](https://github.com/facebook/docusaurus/pull/6245) feat(content-blog): parse date from middle of file path ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6388](https://github.com/facebook/docusaurus/pull/6388) feat(content-blog): include tags in feed ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-module-type-aliases`, `docusaurus-theme-classic`, `docusaurus-types`, `docusaurus` + - [#6371](https://github.com/facebook/docusaurus/pull/6371) feat(core, theme-classic): allow overriding htmlLang ([@noomorph](https://github.com/noomorph)) +- `docusaurus-mdx-loader` + - [#6323](https://github.com/facebook/docusaurus/pull/6323) feat(mdx-loader): preserve hash in image src; support GH themed images ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic` + - [#6139](https://github.com/facebook/docusaurus/pull/6139) feat(theme-classic): new navbar item linking to a sidebar ([@lmpham1](https://github.com/lmpham1)) + - [#6239](https://github.com/facebook/docusaurus/pull/6239) feat(content-docs): allow SEO metadata for category index pages ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-sitemap` + - [#6248](https://github.com/facebook/docusaurus/pull/6248) feat(sitemap): remove trailingSlash option; respect noIndex config ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-ideal-image`, `docusaurus-theme-translations` + - [#6173](https://github.com/facebook/docusaurus/pull/6173) feat(ideal-image): allow translating status messages ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-ideal-image` + - [#6155](https://github.com/facebook/docusaurus/pull/6155) feat(ideal-image): new option disableInDev ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-translations` + - [#6169](https://github.com/facebook/docusaurus/pull/6169) feat(theme-translations): add Italian translations ([@mcallisto](https://github.com/mcallisto)) +- `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-types`, `docusaurus` + - [#6166](https://github.com/facebook/docusaurus/pull/6166) feat: async plugin creator functions ([@slorber](https://github.com/slorber)) +- `docusaurus` + - [#6165](https://github.com/facebook/docusaurus/pull/6165) feat(core): async docusaurus.config.js creator function ([@slorber](https://github.com/slorber)) + +#### :boom: Breaking Change + +- `docusaurus-theme-search-algolia` + - [#6407](https://github.com/facebook/docusaurus/pull/6407) feat(search): enable contextual search by default ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia` + - [#6289](https://github.com/facebook/docusaurus/pull/6289) refactor: move @theme/hooks to @docusaurus/theme-common ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#6283](https://github.com/facebook/docusaurus/pull/6283) refactor(theme-classic): apply import/no-named-export eslint rule ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-sitemap` + - [#6248](https://github.com/facebook/docusaurus/pull/6248) feat(sitemap): remove trailingSlash option; respect noIndex config ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :bug: Bug Fix + +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic`, `docusaurus-types`, `docusaurus-utils-common`, `docusaurus-utils`, `docusaurus` + - [#6454](https://github.com/facebook/docusaurus/pull/6454) fix(content-blog): generate feed by reading build output ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#6468](https://github.com/facebook/docusaurus/pull/6468) fix(init): cd to correct path when installing ([@gabrielcsapo](https://github.com/gabrielcsapo)) +- `docusaurus-mdx-loader` + - [#4827](https://github.com/facebook/docusaurus/pull/4827) fix: allow links to JSON in .md files to be transformed as asset links ([@antmcc49](https://github.com/antmcc49)) +- `docusaurus-plugin-content-docs` + - [#6435](https://github.com/facebook/docusaurus/pull/6435) fix(content-docs): make getActivePlugin match plugin paths more exactly ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6310](https://github.com/facebook/docusaurus/pull/6310) fix: highlight appropriate navItem when browsing generated category index ([@tapanchudasama](https://github.com/tapanchudasama)) + - [#6202](https://github.com/facebook/docusaurus/pull/6202) fix(content-docs): quotify path when retrieving git history ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus` + - [#6424](https://github.com/facebook/docusaurus/pull/6424) fix(core): fix css url("image.png"), use css-loader v6 with esModules: false ([@slorber](https://github.com/slorber)) + - [#6378](https://github.com/facebook/docusaurus/pull/6378) fix(core): do not coerce webpack warning to string ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6197](https://github.com/facebook/docusaurus/pull/6197) fix(cli): quotify temp path in deploy command ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6168](https://github.com/facebook/docusaurus/pull/6168) fix(core): update webpack-dev-server + fix deprecation warning ([@slorber](https://github.com/slorber)) +- `docusaurus-logger`, `docusaurus-utils` + - [#6384](https://github.com/facebook/docusaurus/pull/6384) fix(logger): properly stringify objects for logging ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-module-type-aliases`, `docusaurus-theme-classic`, `docusaurus` + - [#6338](https://github.com/facebook/docusaurus/pull/6338) fix(core): error boundary should allow no children ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic` + - [#6314](https://github.com/facebook/docusaurus/pull/6314) fix(theme-classic): fix mobile version dropdown label with only one version ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6288](https://github.com/facebook/docusaurus/pull/6288) fix(theme-classic): add missing role=region to SkipToContent ([@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)) + - [#6213](https://github.com/facebook/docusaurus/pull/6213) refactor(theme-classic): extract common PaginatorNavLink component ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6177](https://github.com/facebook/docusaurus/pull/6177) fix(theme-classic): make React elements in pre render correctly ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-preset-classic`, `docusaurus-theme-classic`, `docusaurus-theme-search-algolia` + - [#6300](https://github.com/facebook/docusaurus/pull/6300) refactor: move exported type definitions to declaration file ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-migrate` + - [#6276](https://github.com/facebook/docusaurus/pull/6276) fix(migrate): migration CLI should correctly migrate gtag options ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-blog` + - [#6244](https://github.com/facebook/docusaurus/pull/6244) fix(content-blog): always convert front matter date as UTC ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader`, `docusaurus-utils`, `docusaurus` + - [#6190](https://github.com/facebook/docusaurus/pull/6190) fix(utils): properly escape Windows paths ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :nail_care: Polish + +- `docusaurus-module-type-aliases` + - [#6469](https://github.com/facebook/docusaurus/pull/6469) fix(module-type-aliases): fix type def for translate params ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-search-algolia` + - [#6407](https://github.com/facebook/docusaurus/pull/6407) feat(search): enable contextual search by default ([@slorber](https://github.com/slorber)) +- `docusaurus-mdx-loader` + - [#6443](https://github.com/facebook/docusaurus/pull/6443) refactor(mdx-loader): use vfile.path to access Markdown file path ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic` + - [#6427](https://github.com/facebook/docusaurus/pull/6427) feat(theme-classic): add aria-current to sidebar category link ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6391](https://github.com/facebook/docusaurus/pull/6391) refactor(theme-classic): add comments to Prism setup; minor refactor ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6240](https://github.com/facebook/docusaurus/pull/6240) refactor(theme-classic): use front matter from metadata for BlogPostPage ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus` + - [#6419](https://github.com/facebook/docusaurus/pull/6419) feat(core): warn users about hand-modifying generated files ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6405](https://github.com/facebook/docusaurus/pull/6405) feat(core): check imported API name when extracting translations ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6291](https://github.com/facebook/docusaurus/pull/6291) feat(core): improve error message for BrowserOnly; better docs ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#5822](https://github.com/facebook/docusaurus/pull/5822) feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6368](https://github.com/facebook/docusaurus/pull/6368) fix(create-docusaurus): add useBaseUrl for image URLs ([@alias-mac](https://github.com/alias-mac)) +- `docusaurus-plugin-content-pages`, `docusaurus-theme-classic` + - [#6400](https://github.com/facebook/docusaurus/pull/6400) feat(content-pages): front matter validation, include front matter in metadata ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader`, `docusaurus-theme-classic` + - [#6339](https://github.com/facebook/docusaurus/pull/6339) feat(mdx-loader): read image dimensions when processing Markdown ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-content-blog` + - [#6388](https://github.com/facebook/docusaurus/pull/6388) feat(content-blog): include tags in feed ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6189](https://github.com/facebook/docusaurus/pull/6189) feat(content-blog): include front matter in loaded content metadata ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-common` + - [#6317](https://github.com/facebook/docusaurus/pull/6317) feat(theme-classic): autoscroll TOC with active link ([@cerkiewny](https://github.com/cerkiewny)) +- `docusaurus-mdx-loader`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-theme-search-algolia`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus` + - [#6303](https://github.com/facebook/docusaurus/pull/6303) test(utils, mdx-loader, core): improve coverage ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-plugin-google-analytics`, `docusaurus-plugin-google-gtag`, `docusaurus-preset-classic` + - [#6284](https://github.com/facebook/docusaurus/pull/6284) fix(preset-classic): throw if preset finds GA options in theme config ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus`, `docusaurus` + - [#6186](https://github.com/facebook/docusaurus/pull/6186) refactor: print trailing new line when outputting JSON ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :memo: Documentation + +- Other + - [#6296](https://github.com/facebook/docusaurus/pull/6296) docs: add advanced guides ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6459](https://github.com/facebook/docusaurus/pull/6459) docs: add replicad to showcase ([@sgenoud](https://github.com/sgenoud)) + - [#6334](https://github.com/facebook/docusaurus/pull/6334) docs: 2021 recap blog post ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6458](https://github.com/facebook/docusaurus/pull/6458) docs: add Kuizuo's Personal Website to showcase ([@kuizuo](https://github.com/kuizuo)) + - [#6431](https://github.com/facebook/docusaurus/pull/6431) docs: add Koyeb as a deployment option ([@edouardb](https://github.com/edouardb)) + - [#6455](https://github.com/facebook/docusaurus/pull/6455) docs: add Sass Fairy to showcase ([@roydukkey](https://github.com/roydukkey)) + - [#6453](https://github.com/facebook/docusaurus/pull/6453) docs: document embedding generated index in doc page ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6450](https://github.com/facebook/docusaurus/pull/6450) docs: split sidebar documentation into sections ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6449](https://github.com/facebook/docusaurus/pull/6449) docs: multiple doc improvements ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6448](https://github.com/facebook/docusaurus/pull/6448) fix(website): update colors correctly when palette is only customized in one color mode ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6385](https://github.com/facebook/docusaurus/pull/6385) chore: add height/width for front page images ([@nschonni](https://github.com/nschonni)) + - [#6445](https://github.com/facebook/docusaurus/pull/6445) docs: update showcase data of InfraQL ([@jeffreyaven](https://github.com/jeffreyaven)) + - [#6433](https://github.com/facebook/docusaurus/pull/6433) docs: add kube-green to showcase ([@davidebianchi](https://github.com/davidebianchi)) + - [#6428](https://github.com/facebook/docusaurus/pull/6428) docs: elaborate on i18n tutorial ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6422](https://github.com/facebook/docusaurus/pull/6422) docs: add 404Lab wiki to showcase ([@HiChen404](https://github.com/HiChen404)) + - [#6420](https://github.com/facebook/docusaurus/pull/6420) fix(website): restore some site CSS in light mode ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6410](https://github.com/facebook/docusaurus/pull/6410) docs: add SODA for SPARC to showcase ([@megasanjay](https://github.com/megasanjay)) + - [#6417](https://github.com/facebook/docusaurus/pull/6417) docs: fix accessibility of search modal ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6406](https://github.com/facebook/docusaurus/pull/6406) docs(i18n): add docs for htmlLang config ([@noomorph](https://github.com/noomorph)) + - [#6393](https://github.com/facebook/docusaurus/pull/6393) docs: update Algolia docs for new DocSearch infra ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6383](https://github.com/facebook/docusaurus/pull/6383) docs: elaborate on different CSS class names ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6348](https://github.com/facebook/docusaurus/pull/6348) docs: add KaustubhK24's site to showcase ([@kaustubhk24](https://github.com/kaustubhk24)) + - [#6333](https://github.com/facebook/docusaurus/pull/6333) feat(website): search in showcase ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6344](https://github.com/facebook/docusaurus/pull/6344) fix(website): make ColorGenerator functional ([@shwaka](https://github.com/shwaka)) + - [#6340](https://github.com/facebook/docusaurus/pull/6340) docs: minor fix in the sample config for ESM ([@pranabdas](https://github.com/pranabdas)) + - [#6336](https://github.com/facebook/docusaurus/pull/6336) docs: make upgrade guide always show the latest version ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6320](https://github.com/facebook/docusaurus/pull/6320) chore: upgrade rehype-katex with ESM support, update docs ([@pranabdas](https://github.com/pranabdas)) + - [#6335](https://github.com/facebook/docusaurus/pull/6335) docs: add Pglet website to showcase ([@FeodorFitsner](https://github.com/FeodorFitsner)) + - [#6327](https://github.com/facebook/docusaurus/pull/6327) docs: remove typo bracket ([@MorookaKotaro](https://github.com/MorookaKotaro)) + - [#6316](https://github.com/facebook/docusaurus/pull/6316) docs: add bandwidth.com to showcase ([@ajrice6713](https://github.com/ajrice6713)) + - [#6313](https://github.com/facebook/docusaurus/pull/6313) docs: add Refine site to showcase ([@omeraplak](https://github.com/omeraplak)) + - [#6318](https://github.com/facebook/docusaurus/pull/6318) fix(website): various anchor link fixes ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6308](https://github.com/facebook/docusaurus/pull/6308) fix(website): wrap details in mdx-code-block ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6307](https://github.com/facebook/docusaurus/pull/6307) docs: document MD and JSX interoperability issues ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6299](https://github.com/facebook/docusaurus/pull/6299) docs: add icodex to showcase ([@wood3n](https://github.com/wood3n)) + - [#6297](https://github.com/facebook/docusaurus/pull/6297) docs: mention setup in monorepo ([@PatelN123](https://github.com/PatelN123)) + - [#6293](https://github.com/facebook/docusaurus/pull/6293) docs: remove GraphQL mesh from showcase ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6231](https://github.com/facebook/docusaurus/pull/6231) docs: update showcase images; remove GraphQL Code Generator site ([@PatelN123](https://github.com/PatelN123)) + - [#6285](https://github.com/facebook/docusaurus/pull/6285) refactor(website): further optimize showcase images ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6281](https://github.com/facebook/docusaurus/pull/6281) docs: Add kwatch to showcase ([@abahmed](https://github.com/abahmed)) + - [#6280](https://github.com/facebook/docusaurus/pull/6280) docs: elaborate on doc versioning ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6043](https://github.com/facebook/docusaurus/pull/6043) fix(website): resize showcase images, tighten CI check ([@armano2](https://github.com/armano2)) + - [#6274](https://github.com/facebook/docusaurus/pull/6274) docs: add dyte docs to showcase ([@vaibhavshn](https://github.com/vaibhavshn)) + - [#6278](https://github.com/facebook/docusaurus/pull/6278) docs: add Khyron Realm to showcase ([@alexgrigoras](https://github.com/alexgrigoras)) + - [#6271](https://github.com/facebook/docusaurus/pull/6271) docs: add FlatifyCSS to showcase ([@amir2mi](https://github.com/amir2mi)) + - [#6275](https://github.com/facebook/docusaurus/pull/6275) fix(website): fix config-tabs breaking after translation ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6269](https://github.com/facebook/docusaurus/pull/6269) docs: add Ionic to showcase ([@ltm](https://github.com/ltm)) + - [#6272](https://github.com/facebook/docusaurus/pull/6272) docs: make tsconfig work OOTB in typescript guide ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6265](https://github.com/facebook/docusaurus/pull/6265) docs: add Eric JiuRan's blog to showcase ([@1084350607](https://github.com/1084350607)) + - [#6242](https://github.com/facebook/docusaurus/pull/6242) docs(showcase): update oxidizer website url ([@vandreleal](https://github.com/vandreleal)) + - [#6226](https://github.com/facebook/docusaurus/pull/6226) docs: update showcase data for digital support notes ([@PatelN123](https://github.com/PatelN123)) + - [#6224](https://github.com/facebook/docusaurus/pull/6224) docs: add TalentBrick to showcase ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6223](https://github.com/facebook/docusaurus/pull/6223) docs: normalize CodeBlock highlighting ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6214](https://github.com/facebook/docusaurus/pull/6214) feat(website): improve prism themes ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6215](https://github.com/facebook/docusaurus/pull/6215) docs: use BrowserWindow for Markdown demos ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6193](https://github.com/facebook/docusaurus/pull/6193) docs: normalize plugin API documentation ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6209](https://github.com/facebook/docusaurus/pull/6209) docs: elaborate on static asset resolution ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6207](https://github.com/facebook/docusaurus/pull/6207) docs: add default value for BrowserWindow URL field ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6206](https://github.com/facebook/docusaurus/pull/6206) docs: fix highlighting of YAML front matter ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6191](https://github.com/facebook/docusaurus/pull/6191) docs: fix react live scope button color in dark mode ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6188](https://github.com/facebook/docusaurus/pull/6188) docs: add Layer0 to deployment guide ([@rishi-raj-jain](https://github.com/rishi-raj-jain)) + - [#6184](https://github.com/facebook/docusaurus/pull/6184) docs: remove mention of 'UA-' in gtag ([@johnnyreilly](https://github.com/johnnyreilly)) + - [#6181](https://github.com/facebook/docusaurus/pull/6181) docs: add GTFS-to-HTML to showcase ([@brendannee](https://github.com/brendannee)) + - [#6178](https://github.com/facebook/docusaurus/pull/6178) docs: add Digital Support Notes to showcase ([@PatelN123](https://github.com/PatelN123)) + - [#6170](https://github.com/facebook/docusaurus/pull/6170) docs: add LabVIEW coding experience to showcase ([@ruanqizhen](https://github.com/ruanqizhen)) + - [#6164](https://github.com/facebook/docusaurus/pull/6164) docs: fix import module name of theme/Admonition ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6158](https://github.com/facebook/docusaurus/pull/6158) docs: add Astronomer to showcase ([@jwitz](https://github.com/jwitz)) +- `create-docusaurus` + - [#5822](https://github.com/facebook/docusaurus/pull/5822) feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6187](https://github.com/facebook/docusaurus/pull/6187) docs: make installation guide more beginner-friendly ([@PatelN123](https://github.com/PatelN123)) +- `docusaurus-utils` + - [#6204](https://github.com/facebook/docusaurus/pull/6204) docs: recommend highlighting with comments than number range ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus`, `docusaurus-theme-classic` + - [#6203](https://github.com/facebook/docusaurus/pull/6203) docs: audit grammar issues ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :house: Internal + +- `docusaurus-mdx-loader`, `docusaurus-migrate`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-search-algolia`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus` + - [#6456](https://github.com/facebook/docusaurus/pull/6456) chore: add cSpell for spell checking ([@nschonni](https://github.com/nschonni)) +- Other + - [#6444](https://github.com/facebook/docusaurus/pull/6444) misc: update nvmrc to 14.17.0 to meet dependency requirements ([@jodyheavener](https://github.com/jodyheavener)) + - [#6441](https://github.com/facebook/docusaurus/pull/6441) misc: fix stylelint erroring when lint-staged passed ignored file ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6421](https://github.com/facebook/docusaurus/pull/6421) chore: fix yarn build:website:fast ([@slorber](https://github.com/slorber)) + - [#6381](https://github.com/facebook/docusaurus/pull/6381) chore(website): set cache-control for static assets ([@nschonni](https://github.com/nschonni)) + - [#6364](https://github.com/facebook/docusaurus/pull/6364) chore: remove Intl polyfills for Jest ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6325](https://github.com/facebook/docusaurus/pull/6325) chore: add Dependabot for dependency updates ([@nschonni](https://github.com/nschonni)) + - [#6328](https://github.com/facebook/docusaurus/pull/6328) chore(ci): upgrade actions/github-script to v5 ([@nschonni](https://github.com/nschonni)) + - [#6332](https://github.com/facebook/docusaurus/pull/6332) chore(deps): bump follow-redirects from 1.14.5 to 1.14.7 ([@dependabot[bot]](https://github.com/apps/dependabot)) + - [#6326](https://github.com/facebook/docusaurus/pull/6326) misc(ci): remove redundant "CI: true" env ([@nschonni](https://github.com/nschonni)) + - [#6304](https://github.com/facebook/docusaurus/pull/6304) chore: upgrade to Husky 7 ([@nschonni](https://github.com/nschonni)) + - [#6222](https://github.com/facebook/docusaurus/pull/6222) test: ensure consistent CSS ordering ([@slorber](https://github.com/slorber)) + - [#6159](https://github.com/facebook/docusaurus/pull/6159) docs: remove useless comment ([@slorber](https://github.com/slorber)) + - [#6148](https://github.com/facebook/docusaurus/pull/6148) chore(examples): update examples to 2.0.0-beta.14 ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-debug`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia`, `docusaurus` + - [#6442](https://github.com/facebook/docusaurus/pull/6442) chore: enable stylelint standard config ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-ideal-image`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus` + - [#6440](https://github.com/facebook/docusaurus/pull/6440) chore: remove some unused dependencies from package.json ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic` + - [#6436](https://github.com/facebook/docusaurus/pull/6436) refactor(theme-classic): render BlogPostItem as one JSX element ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6283](https://github.com/facebook/docusaurus/pull/6283) refactor(theme-classic): apply import/no-named-export eslint rule ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-pages` + - [#6413](https://github.com/facebook/docusaurus/pull/6413) fix(content-pages): declare hide_table_of_contents as boolean ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-migrate`, `docusaurus-module-type-aliases`, `docusaurus-theme-classic`, `docusaurus` + - [#6399](https://github.com/facebook/docusaurus/pull/6399) refactor: clean up TODO comments ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-cssnano-preset`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-theme-common`, `docusaurus-theme-translations`, `docusaurus` + - [#6387](https://github.com/facebook/docusaurus/pull/6387) test: improve test coverage ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-utils` + - [#6380](https://github.com/facebook/docusaurus/pull/6380) chore: enable a few fixable ESLint rules ([@nschonni](https://github.com/nschonni)) +- `docusaurus-mdx-loader`, `docusaurus-plugin-content-docs`, `docusaurus-utils`, `docusaurus` + - [#6377](https://github.com/facebook/docusaurus/pull/6377) refactor: use findAsyncSequential in a few places ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader`, `docusaurus-migrate`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-docs`, `docusaurus-plugin-content-pages`, `docusaurus-theme-classic`, `docusaurus-theme-search-algolia`, `docusaurus-utils-common`, `docusaurus-utils`, `docusaurus`, `stylelint-copyright` + - [#6375](https://github.com/facebook/docusaurus/pull/6375) chore: enable eslint-plugin-jest ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#6373](https://github.com/facebook/docusaurus/pull/6373) chore: enable react/jsx-closing-bracket-location ([@nschonni](https://github.com/nschonni)) +- `docusaurus-theme-classic`, `stylelint-copyright` + - [#6374](https://github.com/facebook/docusaurus/pull/6374) feat(stylelint-copyright): autofix, stricter config ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-cssnano-preset`, `docusaurus-theme-classic` + - [#6372](https://github.com/facebook/docusaurus/pull/6372) chore: add baseline stylelint rules ([@nschonni](https://github.com/nschonni)) +- `create-docusaurus`, `docusaurus-plugin-debug`, `docusaurus-theme-classic` + - [#6369](https://github.com/facebook/docusaurus/pull/6369) chore: upgrade lint-staged and globs ([@nschonni](https://github.com/nschonni)) +- `docusaurus-theme-search-algolia`, `docusaurus-utils-validation`, `docusaurus` + - [#6341](https://github.com/facebook/docusaurus/pull/6341) chore: regenerate yarn.lock ([@slorber](https://github.com/slorber)) +- `docusaurus-mdx-loader`, `docusaurus-plugin-client-redirects`, `docusaurus-plugin-content-blog`, `docusaurus-plugin-content-pages`, `docusaurus-remark-plugin-npm2yarn`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus` + - [#6324](https://github.com/facebook/docusaurus/pull/6324) chore: minor typo cleanup ([@nschonni](https://github.com/nschonni)) +- `create-docusaurus`, `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-utils-common`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus`, `lqip-loader`, `stylelint-copyright` + - [#6286](https://github.com/facebook/docusaurus/pull/6286) misc: convert all internal scripts to ESM ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-theme-search-algolia` + - [#6289](https://github.com/facebook/docusaurus/pull/6289) refactor: move @theme/hooks to @docusaurus/theme-common ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-search-algolia` + - [#6287](https://github.com/facebook/docusaurus/pull/6287) refactor: new @docusaurus/plugin-content-docs/client interface ([@slorber](https://github.com/slorber)) +- `docusaurus` + - [#6279](https://github.com/facebook/docusaurus/pull/6279) refactor(core): use native types from webpack-dev-server ([@RDIL](https://github.com/RDIL)) +- `docusaurus-plugin-content-docs` + - [#6277](https://github.com/facebook/docusaurus/pull/6277) refactor(content-docs): make readVersionsMetadata async ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-types`, `docusaurus` + - [#6237](https://github.com/facebook/docusaurus/pull/6237) refactor(core): convert serverEntry.js to TS ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus`, `docusaurus-logger`, `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-pwa`, `docusaurus-plugin-sitemap`, `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-theme-live-codeblock`, `docusaurus-utils-common`, `docusaurus-utils-validation`, `docusaurus-utils`, `docusaurus`, `lqip-loader` + - [#6230](https://github.com/facebook/docusaurus/pull/6230) refactor: enforce type import specifiers ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus`, `docusaurus-plugin-content-blog`, `docusaurus-utils`, `docusaurus` + - [#6229](https://github.com/facebook/docusaurus/pull/6229) refactor(utils): reorganize functions; move authors file resolution to utils ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-translations` + - [#6225](https://github.com/facebook/docusaurus/pull/6225) refactor(theme-translations): improve typing for update script ([@Josh-Cena](https://github.com/Josh-Cena)) + - [#6174](https://github.com/facebook/docusaurus/pull/6174) misc(theme-translations): multiple improvements to the update CLI ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### Committers: 46 + +- AJ Rice ([@ajrice6713](https://github.com/ajrice6713)) +- Abdelrahman Ahmed ([@abahmed](https://github.com/abahmed)) +- Alexandru Grigoras ([@alexgrigoras](https://github.com/alexgrigoras)) +- Amir M. Mohamadi ([@amir2mi](https://github.com/amir2mi)) +- Anthony McCaigue ([@antmcc49](https://github.com/antmcc49)) +- Armano ([@armano2](https://github.com/armano2)) +- Brendan Nee ([@brendannee](https://github.com/brendannee)) +- Chen ([@HiChen404](https://github.com/HiChen404)) +- Davide Bianchi ([@davidebianchi](https://github.com/davidebianchi)) +- Devtato ([@cerkiewny](https://github.com/cerkiewny)) +- Edouard Bonlieu ([@edouardb](https://github.com/edouardb)) +- Feodor Fitsner ([@FeodorFitsner](https://github.com/FeodorFitsner)) +- Filipe Guerra ([@alias-mac](https://github.com/alias-mac)) +- Gabriel Csapo ([@gabrielcsapo](https://github.com/gabrielcsapo)) +- Jake Witz ([@jwitz](https://github.com/jwitz)) +- Jeffrey Aven ([@jeffreyaven](https://github.com/jeffreyaven)) +- Jody Heavener ([@jodyheavener](https://github.com/jodyheavener)) +- John Reilly ([@johnnyreilly](https://github.com/johnnyreilly)) +- Joseph ([@josephriosIO](https://github.com/josephriosIO)) +- Josh Goldberg ([@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Kaustubh Kulkarni ([@kaustubhk24](https://github.com/kaustubhk24)) +- Lars Mikkelsen ([@ltm](https://github.com/ltm)) +- Mikey O'Toole ([@homotechsual](https://github.com/homotechsual)) +- Minh Pham ([@lmpham1](https://github.com/lmpham1)) +- Morooka Kotaro ([@MorookaKotaro](https://github.com/MorookaKotaro)) +- Nayan Patel ([@PatelN123](https://github.com/PatelN123)) +- Nick Schonning ([@nschonni](https://github.com/nschonni)) +- Pranab Das ([@pranabdas](https://github.com/pranabdas)) +- Reece Dunham ([@RDIL](https://github.com/RDIL)) +- Rishi Raj Jain ([@rishi-raj-jain](https://github.com/rishi-raj-jain)) +- Sanjay Soundarajan ([@megasanjay](https://github.com/megasanjay)) +- Shun Wakatsuki ([@shwaka](https://github.com/shwaka)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- Tapan Chudasama ([@tapanchudasama](https://github.com/tapanchudasama)) +- Vaibhav Shinde ([@vaibhavshn](https://github.com/vaibhavshn)) +- Vandré Leal ([@vandreleal](https://github.com/vandreleal)) +- Yaroslav Serhieiev ([@noomorph](https://github.com/noomorph)) +- [@mcallisto](https://github.com/mcallisto) +- [@ruanqizhen](https://github.com/ruanqizhen) +- [@wood3n](https://github.com/wood3n) +- kuizuo ([@kuizuo](https://github.com/kuizuo)) +- sgenoud ([@sgenoud](https://github.com/sgenoud)) +- trent ([@roydukkey](https://github.com/roydukkey)) +- Ömer Faruk APLAK ([@omeraplak](https://github.com/omeraplak)) +- 久染 | JiuRan ([@1084350607](https://github.com/1084350607)) + ## 2.0.0-beta.14 (2021-12-21) #### :rocket: New Feature diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index 743c047e86..995e9db7d1 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.14", + "version": "2.0.0-beta.15", "private": true, "scripts": { "start": "netlify dev" diff --git a/lerna.json b/lerna.json index 606f3131a5..61fe6362c7 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.0.0-beta.14", + "version": "2.0.0-beta.15", "npmClient": "yarn", "useWorkspaces": true, "changelog": { diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index 2b2a342054..eb50020692 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.14", + "version": "2.0.0-beta.15", "description": "Create Docusaurus apps easily.", "repository": { "type": "git", @@ -21,7 +21,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.14", + "@docusaurus/logger": "2.0.0-beta.15", "commander": "^5.1.0", "fs-extra": "^10.0.0", "lodash": "^4.17.20", diff --git a/packages/create-docusaurus/templates/classic-typescript/package.json b/packages/create-docusaurus/templates/classic-typescript/package.json index 380464a6a4..f470e201f1 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.14", + "version": "2.0.0-beta.15", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/preset-classic": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/preset-classic": "2.0.0-beta.15", "@mdx-js/react": "^1.6.21", "clsx": "^1.1.1", "prism-react-renderer": "^1.2.1", @@ -24,7 +24,7 @@ "react-dom": "^17.0.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", "@tsconfig/docusaurus": "^1.0.4", "typescript": "^4.5.2" }, diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index 0f73ec0c1c..4430589eb6 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.14", + "version": "2.0.0-beta.15", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/preset-classic": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/preset-classic": "2.0.0-beta.15", "@mdx-js/react": "^1.6.21", "clsx": "^1.1.1", "prism-react-renderer": "^1.2.1", diff --git a/packages/create-docusaurus/templates/facebook/package.json b/packages/create-docusaurus/templates/facebook/package.json index e09e17bc0d..60822412a3 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.14", + "version": "2.0.0-beta.15", "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.14", - "@docusaurus/preset-classic": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/preset-classic": "2.0.0-beta.15", "@mdx-js/react": "^1.6.21", "clsx": "^1.1.1", "react": "^17.0.1", diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index 2f5e5ffb11..e05c7a6d92 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.14", + "version": "2.0.0-beta.15", "description": "Advanced cssnano preset for maximum optimization.", "main": "index.js", "license": "MIT", diff --git a/packages/docusaurus-logger/package.json b/packages/docusaurus-logger/package.json index 226de81f6f..c59bb4ca40 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.14", + "version": "2.0.0-beta.15", "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 2dce287c5e..e29c2a8973 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.14", + "version": "2.0.0-beta.15", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "src/mdx-loader.d.ts", @@ -20,8 +20,8 @@ "dependencies": { "@babel/parser": "^7.16.4", "@babel/traverse": "^7.16.3", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", "@mdx-js/mdx": "^1.6.21", "escape-html": "^1.0.3", "file-loader": "^6.2.0", @@ -36,7 +36,7 @@ "webpack": "^5.61.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/types": "2.0.0-beta.15", "@types/escape-html": "^1.0.1", "@types/mdast": "^3.0.7", "@types/stringify-object": "^3.3.1", diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json index b008942a2c..2af216b25e 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.14", + "version": "2.0.0-beta.15", "description": "A CLI tool to migrate from older versions of Docusaurus.", "main": "lib/index.js", "license": "MIT", @@ -24,7 +24,7 @@ }, "dependencies": { "@babel/preset-env": "^7.16.4", - "@docusaurus/logger": "2.0.0-beta.14", + "@docusaurus/logger": "2.0.0-beta.15", "@mapbox/hast-util-to-jsx": "^1.0.0", "color": "^4.0.1", "commander": "^5.1.0", diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index b8d66ef1cc..b996cc1ba4 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.14", + "version": "2.0.0-beta.15", "description": "Docusaurus module type aliases.", "types": "./src/index.d.ts", "publishConfig": { @@ -12,7 +12,7 @@ "directory": "packages/docusaurus-module-type-aliases" }, "dependencies": { - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/types": "2.0.0-beta.15", "@types/react": "*", "@types/react-helmet": "*", "@types/react-router-config": "*", diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index e6f1b91a62..784c8d8c2b 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.14", + "version": "2.0.0-beta.15", "description": "Client redirects plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-client-redirects.d.ts", @@ -18,18 +18,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-common": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-common": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "eta": "^1.12.3", "fs-extra": "^10.0.0", "lodash": "^4.17.20", "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "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 5c5dd3543f..a4198e81c7 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.14", + "version": "2.0.0-beta.15", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/mdx-loader": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-common": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/mdx-loader": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-common": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "cheerio": "^1.0.0-rc.10", "feed": "^4.2.2", "fs-extra": "^10.0.0", @@ -35,7 +35,7 @@ "webpack": "^5.61.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/types": "2.0.0-beta.15", "escape-string-regexp": "^4.0.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index c456105e1b..7f774c6070 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.14", + "version": "2.0.0-beta.15", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "exports": { @@ -22,11 +22,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/mdx-loader": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/mdx-loader": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "combine-promises": "^1.1.0", "fs-extra": "^10.0.0", "import-fresh": "^3.2.2", @@ -39,8 +39,8 @@ "webpack": "^5.61.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", + "@docusaurus/types": "2.0.0-beta.15", "@types/js-yaml": "^4.0.0", "@types/picomatch": "^2.2.1", "commander": "^5.1.0", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index 6772e2f169..2aa0de50dd 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.14", + "version": "2.0.0-beta.15", "description": "Pages plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-pages.d.ts", @@ -18,10 +18,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/mdx-loader": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/mdx-loader": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "fs-extra": "^10.0.0", "globby": "^11.0.2", "remark-admonitions": "^1.2.1", @@ -29,7 +29,7 @@ "webpack": "^5.61.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 5b2adfba39..07dc856451 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.14", + "version": "2.0.0-beta.15", "description": "Debug plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-debug.d.ts", @@ -18,14 +18,14 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", "fs-extra": "^10.0.0", "react-json-view": "^1.21.3", "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index 9593476867..691c3099fb 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.14", + "version": "2.0.0-beta.15", "description": "Global analytics (analytics.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-google-analytics.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index 2616f708cb..21933fc5a7 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.14", + "version": "2.0.0-beta.15", "description": "Global Site Tag (gtag.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-google-gtag.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index fee95e8e93..824fac3cf6 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.14", + "version": "2.0.0-beta.15", "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", @@ -21,11 +21,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/lqip-loader": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/lqip-loader": "2.0.0-beta.15", "@docusaurus/responsive-loader": "1.5.0", - "@docusaurus/theme-translations": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/theme-translations": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "@endiliey/react-ideal-image": "^0.0.11", "react-waypoint": "^10.1.0", "sharp": "^0.29.1", @@ -33,8 +33,8 @@ "webpack": "^5.61.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", + "@docusaurus/types": "2.0.0-beta.15", "fs-extra": "^10.0.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 50a603c33a..47ebac1dbc 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.14", + "version": "2.0.0-beta.15", "description": "Docusaurus Plugin to add PWA support.", "main": "lib/index.js", "types": "src/plugin-pwa.d.ts", @@ -23,11 +23,11 @@ "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.0", "@babel/plugin-proposal-optional-chaining": "^7.16.0", "@babel/preset-env": "^7.16.4", - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-translations": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-translations": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "babel-loader": "^8.2.2", "clsx": "^1.1.1", "core-js": "^3.18.0", @@ -40,7 +40,7 @@ "workbox-window": "^6.1.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", "fs-extra": "^10.0.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index c3f3b11150..4e8d2eae2b 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.14", + "version": "2.0.0-beta.15", "description": "Simple sitemap generation plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-sitemap.d.ts", @@ -18,16 +18,16 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-common": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-common": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "fs-extra": "^10.0.0", "sitemap": "^7.0.0", "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 8f582c5627..1e87dcc106 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.14", + "version": "2.0.0-beta.15", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "src/preset-classic.d.ts", @@ -18,17 +18,17 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/plugin-content-blog": "2.0.0-beta.14", - "@docusaurus/plugin-content-docs": "2.0.0-beta.14", - "@docusaurus/plugin-content-pages": "2.0.0-beta.14", - "@docusaurus/plugin-debug": "2.0.0-beta.14", - "@docusaurus/plugin-google-analytics": "2.0.0-beta.14", - "@docusaurus/plugin-google-gtag": "2.0.0-beta.14", - "@docusaurus/plugin-sitemap": "2.0.0-beta.14", - "@docusaurus/theme-classic": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-search-algolia": "2.0.0-beta.14" + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/plugin-content-blog": "2.0.0-beta.15", + "@docusaurus/plugin-content-docs": "2.0.0-beta.15", + "@docusaurus/plugin-content-pages": "2.0.0-beta.15", + "@docusaurus/plugin-debug": "2.0.0-beta.15", + "@docusaurus/plugin-google-analytics": "2.0.0-beta.15", + "@docusaurus/plugin-google-gtag": "2.0.0-beta.15", + "@docusaurus/plugin-sitemap": "2.0.0-beta.15", + "@docusaurus/theme-classic": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-search-algolia": "2.0.0-beta.15" }, "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 80ca1b43fc..385634072f 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.14", + "version": "2.0.0-beta.15", "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 5a74747c45..c7cf53782c 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.14", + "version": "2.0.0-beta.15", "description": "Classic theme for Docusaurus", "main": "lib/index.js", "types": "src/theme-classic.d.ts", @@ -21,15 +21,15 @@ "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/plugin-content-blog": "2.0.0-beta.14", - "@docusaurus/plugin-content-docs": "2.0.0-beta.14", - "@docusaurus/plugin-content-pages": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-translations": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-common": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/plugin-content-blog": "2.0.0-beta.15", + "@docusaurus/plugin-content-docs": "2.0.0-beta.15", + "@docusaurus/plugin-content-pages": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-translations": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-common": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "@mdx-js/react": "^1.6.21", "clsx": "^1.1.1", "copy-text-to-clipboard": "^3.0.1", @@ -42,8 +42,8 @@ "rtlcss": "^3.3.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", + "@docusaurus/types": "2.0.0-beta.15", "@types/mdx-js__react": "^1.5.4", "@types/parse-numeric-range": "^0.0.1", "@types/prismjs": "^1.16.2", diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index ac6dd3a14c..220ce0cae6 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.14", + "version": "2.0.0-beta.15", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,18 +18,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/plugin-content-blog": "2.0.0-beta.14", - "@docusaurus/plugin-content-docs": "2.0.0-beta.14", - "@docusaurus/plugin-content-pages": "2.0.0-beta.14", + "@docusaurus/plugin-content-blog": "2.0.0-beta.15", + "@docusaurus/plugin-content-docs": "2.0.0-beta.15", + "@docusaurus/plugin-content-pages": "2.0.0-beta.15", "clsx": "^1.1.1", "parse-numeric-range": "^1.3.0", "tslib": "^2.3.1", "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/module-type-aliases": "2.0.0-beta.14", - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", + "@docusaurus/types": "2.0.0-beta.15", "@testing-library/react-hooks": "^7.0.2", "fs-extra": "^10.0.0", "lodash": "^4.17.20" diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index 0ffe0b5b14..45ac58c657 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.14", + "version": "2.0.0-beta.15", "description": "Docusaurus live code block component.", "main": "lib/index.js", "publishConfig": { @@ -17,10 +17,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-translations": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-translations": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "@philpl/buble": "^0.19.7", "clsx": "^1.1.1", "fs-extra": "^10.0.0", @@ -30,7 +30,7 @@ "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/types": "2.0.0-beta.15", "@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 ab5bb1065e..d10c77ea82 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.14", + "version": "2.0.0-beta.15", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "exports": { @@ -25,12 +25,12 @@ }, "dependencies": { "@docsearch/react": "^3.0.0-alpha.39", - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-translations": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-translations": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "algoliasearch": "^4.10.5", "algoliasearch-helper": "^3.5.5", "clsx": "^1.1.1", @@ -40,7 +40,7 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", "fs-extra": "^10.0.0" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index 0bd360b662..3e6eb9888e 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.14", + "version": "2.0.0-beta.15", "description": "Docusaurus theme translations.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -23,8 +23,8 @@ "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", "lodash": "^4.17.20" }, "engines": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index accb99caea..347b485230 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.14", + "version": "2.0.0-beta.15", "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 004dbdd93a..e9711757a0 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.14", + "version": "2.0.0-beta.15", "description": "Common (Node/Browser) utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -21,7 +21,7 @@ "tslib": "^2.3.1" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14" + "@docusaurus/types": "2.0.0-beta.15" }, "engines": { "node": ">=14" diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index bc6b3bbe5e..312e5aca2e 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.14", + "version": "2.0.0-beta.15", "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.14", - "@docusaurus/utils": "2.0.0-beta.14", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", "joi": "^17.4.2", "tslib": "^2.3.1" }, diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index e7df00d69e..c3d7b5d9ab 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.14", + "version": "2.0.0-beta.15", "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.14", + "@docusaurus/logger": "2.0.0-beta.15", "@mdx-js/runtime": "^1.6.22", "@svgr/webpack": "^6.0.0", "file-loader": "^6.2.0", @@ -39,7 +39,7 @@ "node": ">=14" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/types": "2.0.0-beta.15", "@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 f46997cba1..f423227c57 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.14", + "version": "2.0.0-beta.15", "license": "MIT", "publishConfig": { "access": "public" @@ -41,13 +41,13 @@ "@babel/runtime": "^7.16.3", "@babel/runtime-corejs3": "^7.16.3", "@babel/traverse": "^7.16.3", - "@docusaurus/cssnano-preset": "2.0.0-beta.14", - "@docusaurus/logger": "2.0.0-beta.14", - "@docusaurus/mdx-loader": "2.0.0-beta.14", + "@docusaurus/cssnano-preset": "2.0.0-beta.15", + "@docusaurus/logger": "2.0.0-beta.15", + "@docusaurus/mdx-loader": "2.0.0-beta.15", "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/utils": "2.0.0-beta.14", - "@docusaurus/utils-common": "2.0.0-beta.14", - "@docusaurus/utils-validation": "2.0.0-beta.14", + "@docusaurus/utils": "2.0.0-beta.15", + "@docusaurus/utils-common": "2.0.0-beta.15", + "@docusaurus/utils-validation": "2.0.0-beta.15", "@slorber/static-site-generator-webpack-plugin": "^4.0.0", "@svgr/webpack": "^6.0.0", "autoprefixer": "^10.3.5", @@ -105,8 +105,8 @@ "webpackbar": "^5.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.14", - "@docusaurus/types": "2.0.0-beta.14", + "@docusaurus/module-type-aliases": "2.0.0-beta.15", + "@docusaurus/types": "2.0.0-beta.15", "@types/copy-webpack-plugin": "^8.0.1", "@types/detect-port": "^1.3.0", "@types/mini-css-extract-plugin": "^1.4.3", diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index 15836d4550..d10149f1a4 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.14", + "version": "2.0.0-beta.15", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index ded739db8a..c7138d767b 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.14", + "version": "2.0.0-beta.15", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "index.js", "license": "MIT", diff --git a/website/package.json b/website/package.json index 337d8823a8..1ac8c4bc22 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "2.0.0-beta.14", + "version": "2.0.0-beta.15", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -32,15 +32,15 @@ "dependencies": { "@crowdin/cli": "^3.7.1", "@crowdin/crowdin-api-client": "^1.10.6", - "@docusaurus/core": "2.0.0-beta.14", - "@docusaurus/plugin-client-redirects": "2.0.0-beta.14", - "@docusaurus/plugin-ideal-image": "2.0.0-beta.14", - "@docusaurus/plugin-pwa": "2.0.0-beta.14", - "@docusaurus/preset-classic": "2.0.0-beta.14", - "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.14", - "@docusaurus/theme-common": "2.0.0-beta.14", - "@docusaurus/theme-live-codeblock": "2.0.0-beta.14", - "@docusaurus/utils": "2.0.0-beta.14", + "@docusaurus/core": "2.0.0-beta.15", + "@docusaurus/plugin-client-redirects": "2.0.0-beta.15", + "@docusaurus/plugin-ideal-image": "2.0.0-beta.15", + "@docusaurus/plugin-pwa": "2.0.0-beta.15", + "@docusaurus/preset-classic": "2.0.0-beta.15", + "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.15", + "@docusaurus/theme-common": "2.0.0-beta.15", + "@docusaurus/theme-live-codeblock": "2.0.0-beta.15", + "@docusaurus/utils": "2.0.0-beta.15", "@popperjs/core": "^2.10.2", "clsx": "^1.1.1", "color": "^4.0.1", diff --git a/website/versioned_docs/version-2.0.0-beta.13/advanced/routing.md b/website/versioned_docs/version-2.0.0-beta.13/advanced/routing.md deleted file mode 100644 index 3f39935659..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/advanced/routing.md +++ /dev/null @@ -1,17 +0,0 @@ -# Routing - -This page is only accessible through version-switching. It shows how a versioned doc file becomes a webpage. - -```mdx-code-block -import {useLatestVersion, useActiveDocContext} from '@docusaurus/plugin-content-docs/client'; -import {useLocation} from '@docusaurus/router'; - -export const URLPath = () => {useLocation().pathname}; - -export const FilePath = () => { - const currentVersion = useActiveDocContext('default').activeVersion.name; - return {currentVersion === 'current' ? './docs/' : `./versioned_docs/version-${currentVersion}/`}advanced/routing.md; -} -``` - -This page, , is generated from the file at . The component used is `@theme/DocItem`. diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-client-redirects.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-client-redirects.md deleted file mode 100644 index fca62c4555..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-client-redirects.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -sidebar_position: 4 -id: plugin-client-redirects -title: '📦 plugin-client-redirects' -slug: '/api/plugins/@docusaurus/plugin-client-redirects' ---- - -Docusaurus Plugin to generate **client-side redirects**. - -This plugin will write additional HTML pages to your static site, that redirects the user to your existing Docusaurus pages with JavaScript. - -:::note - -This plugin only create redirects for the production build. - -::: - -:::caution - -It is better to use server-side redirects whenever possible. - -Before using this plugin, you should look if your hosting provider doesn't offer this feature. - -::: - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-client-redirects -``` - -## Configuration {#configuration} - -Main usecase: you have `/myDocusaurusPage`, and you want to redirect to this page from `/myDocusaurusPage.html`: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-client-redirects', - { - fromExtensions: ['html'], - }, - ], - ], -}; -``` - -Second usecase: you have `/myDocusaurusPage.html`, and you want to redirect to this page from `/myDocusaurusPage`. - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-client-redirects', - { - toExtensions: ['html'], - }, - ], - ], -}; -``` - -For custom redirect logic, provide your own `createRedirects` function. - -Let's imagine you change the url of an existing page, you might want to make sure the old url still works: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-client-redirects', - { - redirects: [ - { - to: '/docs/newDocPath', // string - from: ['/docs/oldDocPathFrom2019', '/docs/legacyDocPathFrom2016'], // string | string[] - }, - ], - }, - ], - ], -}; -``` - -It's possible to use a function to create the redirects for each existing path: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-client-redirects', - { - createRedirects: function (existingPath) { - if (existingPath === '/docs/newDocPath') { - return ['/docs/oldDocPathFrom2019', '/docs/legacyDocPathFrom2016']; // string | string[] - } - }, - }, - ], - ], -}; -``` - -Finally, it's possible to use all options at the same time: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-client-redirects', - { - fromExtensions: ['html', 'htm'], - toExtensions: ['exe', 'zip'], - redirects: [ - { - to: '/docs/newDocPath', - from: '/docs/oldDocPath', - }, - ], - createRedirects: function (existingPath) { - if (existingPath === '/docs/newDocPath2') { - return ['/docs/oldDocPath2']; - } - }, - }, - ], - ], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-debug.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-debug.md deleted file mode 100644 index 43f57305b5..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-debug.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -sidebar_position: 5 -id: plugin-debug -title: '📦 plugin-debug' -slug: '/api/plugins/@docusaurus/plugin-debug' ---- - -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). - -It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. - -:::note - -If you report a bug, we will probably ask you to have this plugin turned on in the production, so that we can inspect your deployment config more easily. - -If you don't have any sensitive information, you can keep it on in production [like we do](http://docusaurus.io/__docusaurus/debug). - -::: - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-debug -``` - -:::tip - -If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. You can also configure it through the [classic preset options](presets.md#docusauruspreset-classic) instead of doing it like below. - -By default, it's enabled in dev, and disabled in prod, to avoid exposing potentially sensitive information. - -::: - -## Configuration {#configuration} - -```js title="docusaurus.config.js" -module.exports = { - plugins: ['@docusaurus/plugin-debug'], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-analytics.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-analytics.md deleted file mode 100644 index c38a45394b..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-analytics.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -sidebar_position: 6 -id: plugin-google-analytics -title: '📦 plugin-google-analytics' -slug: '/api/plugins/@docusaurus/plugin-google-analytics' ---- - -The default [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/) plugin. It is a JavaScript library for measuring how users interact with your website **in the production build**. If you are using Google Analytics 4 you might need to consider using [plugin-google-gtag](./plugin-google-gtag.md) instead. - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-google-analytics -``` - -:::tip - -If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. - -::: - -## Configuration {#configuration} - -Accepted fields: - - - -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `trackingID` | `string` | **Required** | The tracking ID of your analytics service. | -| `anonymizeIP` | `boolean` | `false` | Whether the IP should be anonymized when sending requests. | - - - -## Example configuration {#ex-config} - -Here's an example configuration object. - -You can provide it as [preset options](#ex-config-preset) or [plugin options](#ex-config-plugin). - -:::tip - -Most Docusaurus users configure this plugin through the [preset options](#ex-config-preset). - -::: - -```js -const config = { - trackingID: 'UA-141789564-1', - anonymizeIP: true, -}; -``` - -### Preset options {#ex-config-preset} - -If you use a preset, configure this plugin through the [preset options](presets.md#docusauruspreset-classic): - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - // highlight-start - googleAnalytics: { - trackingID: 'UA-141789564-1', - anonymizeIP: true, - }, - // highlight-end - }, - ], - ], -}; -``` - -### Plugin options {#ex-config-plugin} - -If you are using a standalone plugin, provide options directly to the plugin: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-google-analytics', - // highlight-start - { - trackingID: 'UA-141789564-1', - anonymizeIP: true, - }, - // highlight-end - ], - ], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-gtag.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-gtag.md deleted file mode 100644 index 756dc83fd4..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-google-gtag.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -sidebar_position: 7 -id: plugin-google-gtag -title: '📦 plugin-google-gtag' -slug: '/api/plugins/@docusaurus/plugin-google-gtag' ---- - -The default [Global Site Tag (gtag.js)](https://developers.google.com/analytics/devguides/collection/gtagjs/) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform, **in the production build**. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics. - -:::tip - -You can use [Google's Tag Assistant](https://tagassistant.google.com/) tool to check if your gtag is set up correctly! - -::: - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-google-gtag -``` - -:::tip - -If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. - -::: - -## Configuration {#configuration} - -Accepted fields: - - - -| Name | Type | Default | Description | -| --- | --- | --- | --- | -| `trackingID` | `string` | **Required** | The tracking ID of your gtag service. | -| `anonymizeIP` | `boolean` | `false` | Whether the IP should be anonymized when sending requests. | - - - -## Example configuration {#ex-config} - -Here's an example configuration object. - -You can provide it as [preset options](#ex-config-preset) or [plugin options](#ex-config-plugin). - -:::tip - -Most Docusaurus users configure this plugin through the [preset options](#ex-config-preset). - -::: - -```js -const config = { - trackingID: 'UA-141789564-1', - anonymizeIP: true, -}; -``` - -### Preset options {#ex-config-preset} - -If you use a preset, configure this plugin through the [preset options](presets.md#docusauruspreset-classic): - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - // highlight-start - gtag: { - trackingID: 'UA-141789564-1', - anonymizeIP: true, - }, - // highlight-end - }, - ], - ], -}; -``` - -### Plugin options {#ex-config-plugin} - -If you are using a standalone plugin, provide options directly to the plugin: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-google-gtag', - // highlight-start - { - trackingID: 'UA-141789564-1', - anonymizeIP: true, - }, - // highlight-end - ], - ], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-ideal-image.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-ideal-image.md deleted file mode 100644 index 363946e698..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-ideal-image.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -sidebar_position: 8 -id: plugin-ideal-image -title: '📦 plugin-ideal-image' -slug: '/api/plugins/@docusaurus/plugin-ideal-image' ---- - -Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder) **in the production builds**. - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-ideal-image -``` - -## Configuration {#configuration} - -Modify your `docusaurus.config.js` - -```js {3} -module.exports = { - ... - plugins: ['@docusaurus/plugin-ideal-image'], - ... -} -``` - -## Usage {#usage} - -This plugin supports the PNG and JPG formats only. - -```jsx -import Image from '@theme/IdealImage'; -import thumbnail from './path/to/img.png'; - -// your React code - - -// or - -``` - -## Options {#options} - -| Option | Type | Default | Description | -| --- | --- | --- | --- | -| `name` | `string` | `ideal-img/[name].[hash:hex:7].[width].[ext]` | Filename template for output files. | -| `sizes` | `array` | _original size_ | Specify all widths you want to use. If a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). | -| `size` | `integer` | _original size_ | Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up) | -| `min` | `integer` | | As an alternative to manually specifying `sizes`, you can specify `min`, `max` and `steps`, and the sizes will be generated for you. | -| `max` | `integer` | | See `min` above | -| `steps` | `integer` | `4` | Configure the number of images generated between `min` and `max` (inclusive) | -| `quality` | `integer` | `85` | JPEG compression quality | diff --git a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-sitemap.md b/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-sitemap.md deleted file mode 100644 index 5e61a00b76..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/api/plugins/plugin-sitemap.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -sidebar_position: 10 -id: plugin-sitemap -title: '📦 plugin-sitemap' -slug: '/api/plugins/@docusaurus/plugin-sitemap' ---- - -This plugin creates sitemap for your site so that search engine crawlers can crawl your site more accurately. - -## Installation {#installation} - -```bash npm2yarn -npm install --save @docusaurus/plugin-sitemap -``` - -:::tip - -If you have installed `@docusaurus/preset-classic`, you don't need to install it as a dependency. You can also configure it through the [classic preset options](presets.md#docusauruspreset-classic) instead of doing it like below. - -::: - -## Configuration {#configuration} - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-sitemap', - { - changefreq: 'weekly', - priority: 0.5, - trailingSlash: false, - }, - ], - ], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/docs-introduction.md b/website/versioned_docs/version-2.0.0-beta.13/guides/docs/docs-introduction.md deleted file mode 100644 index 0612e7b089..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/docs-introduction.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: introduction -title: Docs Introduction -sidebar_label: Introduction -slug: /docs-introduction ---- - -The docs feature provides users with a way to organize Markdown files in a hierarchical format. - -:::info - -Check the [Docs Plugin API Reference documentation](./../../api/plugins/plugin-content-docs.md) for an exhaustive list of options. - -::: - -## Document ID {#document-id} - -Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory. - -For example, `greeting.md` id is `greeting` and `guide/hello.md` id is `guide/hello`. - -```bash -website # Root directory of your site -└── docs -   ├── greeting.md - └── guide - └── hello.md -``` - -However, the **last part** of the `id` can be defined by user in the front matter. For example, if `guide/hello.md`'s content is defined as below, its final `id` is `guide/part1`. - -```yml ---- -id: part1 ---- -Lorem ipsum -``` - -If you want more control over the last part of the document URL, it is possible to add a `slug` (defaults to the `id`). - -```yml ---- -id: part1 -slug: part1.html ---- -Lorem ipsum -``` - -:::note - -It is possible to use: - -- absolute slugs: `slug: /mySlug`, `slug: /`... -- relative slugs: `slug: mySlug`, `slug: ./../mySlug`... - -::: - -## Home page docs {#home-page-docs} - -If you want a document to be available at the root, and have a path like `https://docusaurus.io/docs/`, you can use the slug frontmatter: - -```yml ---- -id: my-home-doc -slug: / ---- -Lorem ipsum -``` - -## Docs-only mode {#docs-only-mode} - -If you only want the documentation feature, you can run your Docusaurus 2 site without a landing page and display your documentation page as the index page instead. - -To enable docs-only mode, set the docs plugin `routeBasePath: '/'`, and use the frontmatter `slug: /` on the document that should be the index page ([more info](#home-page-docs)). - -:::caution - -You should delete the existing homepage at `./src/pages/index.js`, or else there will be two files mapping to the same route! - -::: - -:::tip - -There's also a "blog-only mode" for those who only want to use the blog feature of Docusaurus 2. You can use the same method detailed above. Follow the setup instructions on [Blog-only mode](../../blog.mdx#blog-only-mode). - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/sidebar.md b/website/versioned_docs/version-2.0.0-beta.13/guides/docs/sidebar.md deleted file mode 100644 index f430b78c71..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/sidebar.md +++ /dev/null @@ -1,809 +0,0 @@ ---- -id: sidebar -title: Sidebar -toc_max_heading_level: 5 -slug: /sidebar ---- - -Creating a sidebar is useful to: - -- Group multiple **related documents** -- **Display a sidebar** on each of those documents -- Provide a **paginated navigation**, with next/previous button - -To use sidebars on your Docusaurus site: - -1. Define a file that exports a [sidebar object](#sidebar-object). -1. Pass this object into the `@docusaurus/plugin-docs` plugin directly or via `@docusaurus/preset-classic`. - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - // highlight-next-line - sidebarPath: require.resolve('./sidebars.js'), - }, - }, - ], - ], -}; -``` - -## Default sidebar - -By default, Docusaurus [automatically generates a sidebar](#sidebar-item-autogenerated) for you, by using the filesystem structure of the `docs` folder: - -```js title="sidebars.js" -module.exports = { - mySidebar: [ - { - type: 'autogenerated', - dirName: '.', // generate sidebar slice from the docs folder (or versioned_docs/) - }, - ], -}; -``` - -You can also define your sidebars explicitly. - -## Sidebar object {#sidebar-object} - -A sidebar is a **tree of [sidebar items](#understanding-sidebar-items)**. - -```typescript -type Sidebar = - // Normal syntax - | SidebarItem[] - - // Shorthand syntax - | Record< - string, // category label - SidebarItem[] // category items - >; -``` - -A sidebars file can contain **multiple sidebar objects**. - -```typescript -type SidebarsFile = Record< - string, // sidebar id - Sidebar ->; -``` - -Example: - -```js title="sidebars.js" -module.exports = { - mySidebar: [ - { - type: 'category', - label: 'Getting Started', - items: ['doc1'], - }, - { - type: 'category', - label: 'Docusaurus', - items: ['doc2', 'doc3'], - }, - ], -}; -``` - -Notice the following: - -- There is a single sidebar `mySidebar`, containing 5 [sidebar items](#understanding-sidebar-items) -- `Getting Started` and `Docusaurus` are sidebar categories -- `doc1`, `doc2` and `doc3` are sidebar documents - -:::tip - -Use the **shorthand syntax** to express this sidebar more concisely: - -```js title="sidebars.js" -module.exports = { - mySidebar: { - 'Getting started': ['doc1'], - Docusaurus: ['doc2', 'doc3'], - }, -}; -``` - -::: - -## Using multiple sidebars {#using-multiple-sidebars} - -You can create a sidebar for each **set of Markdown files** that you want to **group together**. - -:::tip - -The Docusaurus site is a good example of using multiple sidebars: - -- [Docs](../../introduction.md) -- [API](../../cli.md) - -::: - -Example: - -```js title="sidebars.js" -module.exports = { - tutorialSidebar: { - 'Category A': ['doc1', 'doc2'], - }, - apiSidebar: ['doc3', 'doc4'], -}; -``` - -:::note - -The keys `tutorialSidebar` and `apiSidebar` are sidebar **technical ids** and do not matter much. - -::: - -When browsing: - -- `doc1` or `doc2`: the `tutorialSidebar` will be displayed -- `doc3` or `doc4`: the `apiSidebar` will be displayed - -A **paginated navigation** link documents inside the same sidebar with **next and previous buttons**. - -## Understanding sidebar items {#understanding-sidebar-items} - -`SidebarItem` is an item defined in a Sidebar tree. - -There are different types of sidebar items: - -- **[Doc](#sidebar-item-doc)**: link to a doc page, assigning it to the sidebar -- **[Ref](#sidebar-item-ref)**: link to a doc page, without assigning it to the sidebar -- **[Link](#sidebar-item-link)**: link to any internal or external page -- **[Category](#sidebar-item-category)**: create a hierarchy of sidebar items -- **[Autogenerated](#sidebar-item-autogenerated)**: generate a sidebar slice automatically - -### Doc: link to a doc {#sidebar-item-doc} - -Use the `doc` type to link to a doc page and assign that doc to a sidebar: - -```typescript -type SidebarItemDoc = - // Normal syntax - | { - type: 'doc'; - id: string; - label: string; // Sidebar label text - className?: string; // Class name for sidebar label - } - - // Shorthand syntax - | string; // docId shortcut -``` - -Example: - -```js title="sidebars.js" -module.exports = { - mySidebar: [ - // Normal syntax: - // highlight-start - { - type: 'doc', - id: 'doc1', // document id - label: 'Getting started', // sidebar label - }, - // highlight-end - - // Shorthand syntax: - // highlight-start - 'doc2', // document id - // highlight-end - ], -}; -``` - -The `sidebar_label` markdown frontmatter has a higher precedence over the `label` key in `SidebarItemDoc`. - -:::note - -Don't assign the same doc to multiple sidebars: use a [ref](#sidebar-item-ref) instead. - -::: - -### Ref: link to a doc, without sidebar {#sidebar-item-ref} - -Use the `ref` type to link to a doc page without assigning it to a sidebar. - -```typescript -type SidebarItemRef = { - type: 'ref'; - id: string; -}; -``` - -Example: - -```js title="sidebars.js" -module.exports = { - mySidebar: [ - { - type: 'ref', - id: 'doc1', // Document id (string). - }, - ], -}; -``` - -When browsing `doc1`, Docusaurus **will not display** the `mySidebar` sidebar. - -### Link: link to any page {#sidebar-item-link} - -Use the `link` type to link to any page (internal or external) that is not a doc. - -```typescript -type SidebarItemLink = { - type: 'link'; - label: string; - href: string; - className?: string; -}; -``` - -Example: - -```js title="sidebars.js" -module.exports = { - myLinksSidebar: [ - // highlight-start - // External link - { - type: 'link', - label: 'Facebook', // The link label - href: 'https://facebook.com', // The external URL - }, - // highlight-end - - // highlight-start - // Internal link - { - type: 'link', - label: 'Home', // The link label - href: '/', // The internal path - }, - // highlight-end - ], -}; -``` - -### Category: create a hierarchy {#sidebar-item-category} - -Use the `category` type to create a hierarchy of sidebar items. - -```typescript -type SidebarItemCategory = { - type: 'category'; - label: string; // Sidebar label text. - items: SidebarItem[]; // Array of sidebar items. - className?: string; - - // Category options: - collapsible: boolean; // Set the category to be collapsible - collapsed: boolean; // Set the category to be initially collapsed or open by default - link: SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndex; -}; -``` - -Example: - -```js title="sidebars.js" -module.exports = { - docs: [ - { - type: 'category', - label: 'Guides', - collapsible: true, - collapsed: false, - items: [ - 'creating-pages', - { - type: 'category', - label: 'Docs', - items: ['introduction', 'sidebar', 'markdown-features', 'versioning'], - }, - ], - }, - ], -}; -``` - -:::tip - -Use the **shorthand syntax** when you don't need **category options**: - -```js title="sidebars.js" -module.exports = { - docs: { - Guides: [ - 'creating-pages', - { - Docs: ['introduction', 'sidebar', 'markdown-features', 'versioning'], - }, - ], - }, -}; -``` - -::: - -#### Category links {#category-link} - -With category links, clicking on a category can navigate you to another page. - -:::tip - -Use category links to introduce a category of documents. - -::: - -##### Doc link {#category-doc-link} - -A category can link to an existing document. - -```js title="sidebars.js" -module.exports = { - docs: [ - { - type: 'category', - label: 'Guides', - // highlight-start - link: {type: 'doc', id: 'introduction'}, - // highlight-end - items: ['pages', 'docs', 'blog', 'search'], - }, - ], -}; -``` - -See it in action in the [i18n introduction page](../../i18n/i18n-introduction.md). - -##### Generated index page {#generated-index-page} - -You can auto-generate an index page that displays all the direct children of this category. The `slug` allows you to customize the generated page's route, which defaults to `/category/{{category name}}`. - -```js title="sidebars.js" -module.exports = { - docs: [ - { - type: 'category', - label: 'Guides', - // highlight-start - link: { - type: 'generated-index', - title: 'Docusaurus Guides', - description: 'Learn about the most important Docusaurus concepts!', - slug: '/category/docusaurus-guides', - }, - // highlight-end - items: ['pages', 'docs', 'blog', 'search'], - }, - ], -}; -``` - -See it in action in the [Docusaurus Guides pages](/docs/category/guides). - -:::tip - -Use `generated-index` links as a quick way to get an introductory document. - -::: - -#### Collapsible categories {#collapsible-categories} - -We support the option to expand/collapse categories. Categories are collapsible by default, but you can disable collapsing with `collapsible: false`. - -```js title="sidebars.js" -module.exports = { - docs: [ - { - type: 'category', - label: 'Guides', - items: [ - 'creating-pages', - { - type: 'category', - // highlight-next-line - collapsible: false, - label: 'Docs', - items: ['introduction', 'sidebar', 'markdown-features', 'versioning'], - }, - ], - }, - ], -}; -``` - -To make all categories non-collapsible by default, set the `sidebarCollapsible` option in `plugin-docs` to `false`: - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - // highlight-next-line - sidebarCollapsible: false, - }, - }, - ], - ], -}; -``` - -:::note - -The option in `sidebars.js` takes precedence over plugin configuration, so it is possible to make certain categories collapsible when `sidebarCollapsible` is set to `false` globally. - -::: - -#### Expanded categories by default {#expanded-categories-by-default} - -Collapsible categories are collapsed by default. If you want them to be expanded on first render, you can set `collapsed` to `false`: - -```js title="sidebars.js" -module.exports = { - docs: { - Guides: [ - 'creating-pages', - { - type: 'category', - label: 'Docs', - // highlight-next-line - collapsed: false, - items: ['markdown-features', 'sidebar', 'versioning'], - }, - ], - }, -}; -``` - -Similar to `collapsible`, you can also set the global configuration `options.sidebarCollapsed` to `false`. Individual `collapsed` options in `sidebars.js` will still take precedence over this configuration. - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - // highlight-next-line - sidebarCollapsed: false, - }, - }, - ], - ], -}; -``` - -:::caution - -When a category has `collapsed: true` but `collapsible: false` (either through `sidebars.js` or through plugin configuration), the latter takes precedence and the category is still rendered as expanded. - -::: - -### Autogenerated: generate a sidebar {#sidebar-item-autogenerated} - -Docusaurus can **create a sidebar automatically** from your **filesystem structure**: each folder creates a sidebar category. - -An `autogenerated` item is converted by Docusaurus to a **sidebar slice**: a list of items of type `doc` and `category`. - -```typescript -type SidebarItemAutogenerated = { - type: 'autogenerated'; - dirName: string; // Source folder to generate the sidebar slice from (relative to docs) -}; -``` - -Docusaurus can generate a sidebar from your docs folder: - -```js title="sidebars.js" -module.exports = { - myAutogeneratedSidebar: [ - // highlight-start - { - type: 'autogenerated', - dirName: '.', // '.' means the current docs folder - }, - // highlight-end - ], -}; -``` - -You can also use **multiple `autogenerated` items** in a sidebar, and interleave them with regular sidebar items: - -```js title="sidebars.js" -module.exports = { - mySidebar: [ - 'intro', - { - type: 'category', - label: 'Tutorials', - items: [ - 'tutorial-intro', - // highlight-start - { - type: 'autogenerated', - dirName: 'tutorials/easy', // Generate sidebar slice from docs/tutorials/easy - }, - // highlight-end - 'tutorial-medium', - // highlight-start - { - type: 'autogenerated', - dirName: 'tutorials/advanced', // Generate sidebar slice from docs/tutorials/hard - }, - // highlight-end - 'tutorial-end', - ], - }, - // highlight-start - { - type: 'autogenerated', - dirName: 'guides', // Generate sidebar slice from docs/guides - }, - // highlight-end - { - type: 'category', - label: 'Community', - items: ['team', 'chat'], - }, - ], -}; -``` - -#### Category index convention {#category-index-convention} - -Docusaurus can automatically link a category to its index document. - -A category index document is a document following one of those filename conventions: - -- Named as `index` (case-insensitive): `docs/Guides/index.md` -- Named as `README` (case-insensitive): `docs/Guides/README.mdx` -- Same name as parent folder: `docs/Guides/Guides.md` - -This is equivalent to using a category with a [doc link](#category-doc-link): - -```js title="sidebars.js" -module.exports = { - docs: [ - // highlight-start - { - type: 'category', - label: 'Guides', - link: {type: 'doc', id: 'Guides/index'}, - items: [], - }, - // highlight-end - ], -}; -``` - -:::tip - -Naming your introductory document `README.md` makes it show up when browsing the folder using the GitHub interface, while using `index.md` makes the behavior more in line with how HTML files are served. - -::: - -#### Autogenerated sidebar metadata {#autogenerated-sidebar-metadata} - -By default, the sidebar slice will be generated in **alphabetical order** (using files and folders names). - -If the generated sidebar does not look good, you can assign additional metadata to docs and categories. - -**For docs**: use additional front matter: - -```md title="docs/tutorials/tutorial-easy.md" {1-4} ---- -sidebar_label: Easy -sidebar_position: 2 ---- - -# Easy Tutorial - -This is the easy tutorial! -``` - -**For categories**: add a `_category_.json` or `_category_.yml` file in the appropriate folder: - -```json title="docs/tutorials/_category_.json" -{ - "label": "Tutorial", - "position": 3, - "className": "red", - "link": { - "type": "generated-index", - "title": "Tutorial overview" - } -} -``` - -:::info - -If the `link` is explicitly specified, Docusaurus will not apply any [default conventions](#category-index-convention). - -The doc links can be specified relatively, e.g. if the category is generated with the `guides` directory, `"link": {"type": "doc", "id": "intro"}` will be resolved to the ID `guides/intro`, only falling back to `intro` if a doc with the former ID doesn't exist. - -::: - -```yaml title="docs/tutorials/_category_.yml" -label: 'Tutorial' -position: 2.5 # float position is supported -collapsible: true # make the category collapsible -collapsed: false # keep the category open by default -``` - -:::info - -The position metadata is only used **inside a sidebar slice**: Docusaurus does not re-order other items of your sidebar. - -::: - -#### Using number prefixes - -A simple way to order an autogenerated sidebar is to prefix docs and folders by number prefixes: - -```bash -docs -├── 01-Intro.md -├── 02-Tutorial Easy -│   ├── 01-First Part.md -│   ├── 02-Second Part.md -│   └── 03-End.md -├── 03-Tutorial Hard -│   ├── 01-First Part.md -│   ├── 02-Second Part.md -│   ├── 03-Third Part.md -│   └── 04-End.md -└── 04-End.md -``` - -To make it **easier to adopt**, Docusaurus supports **multiple number prefix patterns**. - -By default, Docusaurus will **remove the number prefix** from the doc id, title, label and URL paths. - -:::caution - -**Prefer using [additional metadata](#autogenerated-sidebar-metadata)**. - -Updating a number prefix can be annoying, as it can require **updating multiple existing markdown links**: - -```diff title="docs/02-Tutorial Easy/01-First Part.md" -- Check the [Tutorial End](../04-End.md); -+ Check the [Tutorial End](../05-End.md); -``` - -::: - -#### Customize the sidebar items generator - -You can provide a custom `sidebarItemsGenerator` function in the docs plugin (or preset) config: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-content-docs', - { - // highlight-start - sidebarItemsGenerator: async function ({ - defaultSidebarItemsGenerator, - numberPrefixParser, - item, - version, - docs, - }) { - // Example: return an hardcoded list of static sidebar items - return [ - {type: 'doc', id: 'doc1'}, - {type: 'doc', id: 'doc2'}, - ]; - }, - // highlight-end - }, - ], - ], -}; -``` - -:::tip - -**Re-use and enhance the default generator** instead of writing a generator from scratch. - -**Add, update, filter, re-order** the sidebar items according to your use-case: - -```js title="docusaurus.config.js" -// highlight-start -// Reverse the sidebar items ordering (including nested category items) -function reverseSidebarItems(items) { - // Reverse items in categories - const result = items.map((item) => { - if (item.type === 'category') { - return {...item, items: reverseSidebarItems(item.items)}; - } - return item; - }); - // Reverse items at current level - result.reverse(); - return result; -} -// highlight-end - -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-content-docs', - { - // highlight-start - sidebarItemsGenerator: async function ({ - defaultSidebarItemsGenerator, - ...args - }) { - const sidebarItems = await defaultSidebarItemsGenerator(args); - return reverseSidebarItems(sidebarItems); - }, - // highlight-end - }, - ], - ], -}; -``` - -::: - -## Hideable sidebar {#hideable-sidebar} - -Using the enabled `themeConfig.hideableSidebar` option, you can make the entire sidebar hidden, allowing you to better focus your users on the content. This is especially useful when content consumption on medium screens (e.g. on tablets). - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - // highlight-start - hideableSidebar: true, - // highlight-end - }, -}; -``` - -## Passing custom props {#passing-custom-props} - -To pass in custom props to a swizzled sidebar item, add the optional `customProps` object to any of the items: - -```js -{ - type: 'doc', - id: 'doc1', - customProps: { - /* props */ - } -} -``` - -## Complex sidebars example {#complex-sidebars-example} - -Real-world example from the Docusaurus site: - -```mdx-code-block -import CodeBlock from '@theme/CodeBlock'; - - - {require('!!raw-loader!@site/sidebars.js') - .default - .split('\n') - // remove comments - .map((line) => !['#','/*','*'].some(commentPattern => line.trim().startsWith(commentPattern)) && line) - .filter(Boolean) - .join('\n')} - -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/versioning.md b/website/versioned_docs/version-2.0.0-beta.13/guides/docs/versioning.md deleted file mode 100644 index 5a60fecef8..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/docs/versioning.md +++ /dev/null @@ -1,216 +0,0 @@ ---- -id: versioning -title: Versioning -slug: /versioning ---- - -You can use the version script to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory changes moving forward. - -:::caution - -Think about it before starting to version your documentation - it can become difficult for contributors to help improve it! - -::: - -Most of the time, you don't need versioning as it will just increase your build time, and introduce complexity to your codebase. Versioning is **best suited for websites with high-traffic and rapid changes to documentation between versions**. If your documentation rarely changes, don't add versioning to your documentation. - -To better understand how versioning works and see if it suits your needs, you can read on below. - -## Directory structure {#directory-structure} - -```shell -website -├── sidebars.json # sidebar for the current docs version -├── docs # docs directory for the current docs version -│ ├── foo -│ │ └── bar.md # https://mysite.com/docs/next/foo/bar -│ └── hello.md # https://mysite.com/docs/next/hello -├── versions.json # file to indicate what versions are available -├── versioned_docs -│ ├── version-1.1.0 -│ │ ├── foo -│ │ │ └── bar.md # https://mysite.com/docs/foo/bar -│ │ └── hello.md -│ └── version-1.0.0 -│ ├── foo -│ │ └── bar.md # https://mysite.com/docs/1.0.0/foo/bar -│ └── hello.md -├── versioned_sidebars -│ ├── version-1.1.0-sidebars.json -│ └── version-1.0.0-sidebars.json -├── docusaurus.config.js -└── package.json -``` - -The table below explains how a versioned file maps to its version and the generated URL. - -| Path | Version | URL | -| --------------------------------------- | -------------- | ----------------- | -| `versioned_docs/version-1.0.0/hello.md` | 1.0.0 | /docs/1.0.0/hello | -| `versioned_docs/version-1.1.0/hello.md` | 1.1.0 (latest) | /docs/hello | -| `docs/hello.md` | current | /docs/next/hello | - -:::tip - -The files in the `docs` directory belong to the `current` docs version. - -By default, the `current` docs version is labelled as `Next` and hosted under `/docs/next/*`, but is entirely configurable to fit your project's release lifecycle. - -::: - -### Tagging a new version {#tagging-a-new-version} - -1. First, make sure the current docs version (the `docs` directory) is ready to be frozen. -1. Enter a new version number. - -```bash npm2yarn -npm run docusaurus docs:version 1.1.0 -``` - -When tagging a new version, the document versioning mechanism will: - -- Copy the full `docs/` folder contents into a new `versioned_docs/version-/` folder. -- Create a versioned sidebars file based from your current [sidebar](docs-introduction.md#sidebar) configuration (if it exists) - saved as `versioned_sidebars/version--sidebars.json`. -- Append the new version number to `versions.json`. - -## Docs {#docs} - -### Creating new docs {#creating-new-docs} - -1. Place the new file into the corresponding version folder. -1. Include the reference for the new file into the corresponding sidebar file, according to version number. - -**Current version docs** - -```shell -# The new file. -docs/new.md - -# Edit the corresponding sidebar file. -sidebar.js -``` - -**Older version docs** - -```shell -# The new file. -versioned_docs/version-1.0.0/new.md - -# Edit the corresponding sidebar file. -versioned_sidebars/version-1.0.0-sidebars.json -``` - -### Linking docs {#linking-docs} - -- Remember to include the `.md` extension. -- Files will be linked to correct corresponding version. -- Relative paths work as well. - -```md -The [@hello](hello.md#paginate) document is great! - -See the [Tutorial](../getting-started/tutorial.md) for more info. -``` - -## Versions {#versions} - -Each directory in `versioned_docs/` will represent a documentation version. - -### Updating an existing version {#updating-an-existing-version} - -You can update multiple docs versions at the same time because each directory in `versioned_docs/` represents specific routes when published. - -1. Edit any file. -1. Commit and push changes. -1. It will be published to the version. - -Example: When you change any file in `versioned_docs/version-2.6/`, it will only affect the docs for version `2.6`. - -### Deleting an existing version {#deleting-an-existing-version} - -You can delete/remove versions as well. - -1. Remove the version from `versions.json`. - -Example: - -```diff {4} -[ - "2.0.0", - "1.9.0", -- "1.8.0" -] -``` - -2. Delete the versioned docs directory. Example: `versioned_docs/version-1.8.0`. -3. Delete the versioned sidebars file. Example: `versioned_sidebars/version-1.8.0-sidebars.json`. - -## Recommended practices {#recommended-practices} - -### Figure out the behavior for the "current" version {#figure-out-the-behavior-for-the-current-version} - -The "current" version is the version name for the `./docs` folder. - -There are different ways to manage versioning, but two very common patterns are: - -- You release v1, and start immediately working on v2 (including its docs) -- You release v1, and will maintain it for some time before thinking about v2. - -Docusaurus defaults work great for the first usecase. - -**For the 2nd usecase**: if you release v1 and don't plan to work on v2 anytime soon, instead of versioning v1 and having to maintain the docs in 2 folders (`./docs` + `./versioned_docs/version-1.0.0`), you may consider using the following configuration instead: - -```json -{ - "lastVersion": "current", - "versions": { - "current": { - "label": "1.0.0", - "path": "1.0.0" - } - } -} -``` - -The docs in `./docs` will be served at `/docs/1.0.0` instead of `/docs/next`, and `1.0.0` will become the default version we link to in the navbar dropdown, and you will only need to maintain a single `./docs` folder. - -See [docs plugin configuration](../../api/plugins/plugin-content-docs.md) for more details. - -### Version your documentation only when needed {#version-your-documentation-only-when-needed} - -For example, you are building a documentation for your npm package `foo` and you are currently in version 1.0.0. You then release a patch version for a minor bug fix and it's now 1.0.1. - -Should you cut a new documentation version 1.0.1? **You probably shouldn't**. 1.0.1 and 1.0.0 docs shouldn't differ according to semver because there are no new features!. Cutting a new version for it will only just create unnecessary duplicated files. - -### Keep the number of versions small {#keep-the-number-of-versions-small} - -As a good rule of thumb, try to keep the number of your versions below 10. **It is very likely** that you will have a lot of obsolete versioned documentation that nobody even reads anymore. For example, [Jest](https://jestjs.io/versions) is currently in version `24.9`, and only maintains several latest documentation versions with the lowest being `22.X`. Keep it small 😊 - -### Use absolute import within the docs {#use-absolute-import-within-the-docs} - -Don't use relative paths import within the docs. Because when we cut a version the paths no longer work (the nesting level is different, among other reasons). You can utilize the `@site` alias provided by Docusaurus, that points to the `website` directory. Example: - -```diff -- import Foo from '../src/components/Foo'; -+ import Foo from '@site/src/components/Foo'; -``` - -### Global or versioned collocated assets {#global-or-versioned-collocated-assets} - -You should decide if assets like images and files are per version or shared between versions - -If your assets should be versioned, put them in the docs version, and use relative paths: - -```md -![img alt](./myImage.png) - -[download this file](./file.pdf) -``` - -If your assets are global, put them in `/static` and use absolute paths: - -```md -![img alt](/myImage.png) - -[download this file](/file.pdf) -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-admonitions.mdx deleted file mode 100644 index 69784e5dc1..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-admonitions.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -id: admonitions -title: Admonitions -description: Handling admonitions/callouts in Docusaurus Markdown -slug: /markdown-features/admonitions ---- - -In addition to the basic Markdown syntax, we use [remark-admonitions](https://github.com/elviswolcott/remark-admonitions) alongside MDX to add support for admonitions. Admonitions are wrapped by a set of 3 colons. - -Example: - - :::note - - Some **content** with _markdown_ `syntax`. Check [this `api`](#). - - ::: - - :::tip - - Some **content** with _markdown_ `syntax`. Check [this `api`](#). - - ::: - - :::info - - Some **content** with _markdown_ `syntax`. Check [this `api`](#). - - ::: - - :::caution - - Some **content** with _markdown_ `syntax`. Check [this `api`](#). - - ::: - - :::danger - - Some **content** with _markdown_ `syntax`. Check [this `api`](#). - - ::: - -:::note - -Some **content** with _markdown_ `syntax`. Check [this `api`](#). - -::: - -:::tip - -Some **content** with _markdown_ `syntax`. Check [this `api`](#). - -::: - -:::info - -Some **content** with _markdown_ `syntax`. Check [this `api`](#). - -::: - -:::caution - -Some **content** with _markdown_ `syntax`. Check [this `api`](#). - -::: - -:::danger - -Some **content** with _markdown_ `syntax`. Check [this `api`](#). - -::: - -## Specifying title {#specifying-title} - -You may also specify an optional title - - :::note Your Title - - Some **content** with _markdown_ `syntax`. - - ::: - -:::note Your Title - -Some **content** with _markdown_ `syntax`. - -::: - -## Admonitions with MDX - -You can use MDX inside admonitions too! - -```jsx -import Tabs from '@theme/Tabs'; - -import TabItem from '@theme/TabItem'; - -:::tip Use tabs in admonitions - - - This is an apple 🍎 - This is an orange 🍊 - This is a banana 🍌 - - -::: -``` - -```mdx-code-block -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -``` - -:::tip Use tabs in admonitions - -```mdx-code-block - - This is an apple 🍎 - This is an orange 🍊 - This is a banana 🍌 - -``` - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-math-equations.mdx b/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-math-equations.mdx deleted file mode 100644 index b37917b4f2..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-math-equations.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -id: math-equations -title: Math Equations -description: Writing LaTeX Math Equations -slug: /markdown-features/math-equations ---- - -Mathematical equations can be rendered using [KaTeX](https://katex.org). - -## Usage - -Please read [KaTeX](https://katex.org) documentation for more details. - -### Inline - -Write inline math equations by wrapping LaTeX equations between `$`: - -```mdx -Let $f:[a,b] \to \R$ be Riemann integrable. Let $F:[a,b]\to\R$ be $F(x)= -\int_{a}^{x}f(t)dt$. Then $$F$$ is continuous, and at all $x$ such that $f$ is continuous at $x$, $F$ is differentiable at $x$ with $F'(x)=f(x)$. -``` - -Let $f:[a,b] \to \R$ be Riemann integrable. Let $F:[a,b]\to\R$ be $F(x)= -\int_{a}^{x}f(t)dt$. Then $F$ is continuous, and at all $x$ such that $f$ is continuous at $x$, $F$ is differentiable at $x$ with $F'(x)=f(x)$. - -### Blocks - -For equation block or display mode, use line breaks and `$$`: - -```mdx -$$ -I = \int_0^{2\pi} \sin(x) dx -$$ -``` - -$$ -I = \int_0^{2\pi} \sin(x) dx -$$ - -## Configuration - -To enable KaTeX, you need to install `remark-math` and `rehype-katex` plugins. - -```bash npm2yarn -npm install --save remark-math@3 rehype-katex@4 hast-util-is-element@1.1.0 -``` - -:::caution - -Use the exact same versions. The latest versions are incompatible with Docusaurus 2. - -::: - -Import the plugins in `docusaurus.config.js`: - -```js -const math = require('remark-math'); -const katex = require('rehype-katex'); -``` - -Add them to your content plugin or preset options (usually `@docusaurus/preset-classic` docs options): - -```js -remarkPlugins: [math], -rehypePlugins: [katex], -``` - -Include the KaTeX CSS in your config under `stylesheets`: - -```js -stylesheets: [ - { - href: "https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css", - integrity: "sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc", - crossorigin: "anonymous", - }, -], -``` - -Overall the changes look like: - -```js title="docusaurus.config.js" -// highlight-start -const math = require('remark-math'); -const katex = require('rehype-katex'); -// highlight-end - -module.exports = { - title: 'Docusaurus', - tagline: 'Build optimized websites quickly, focus on your content', - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - path: 'docs', - // highlight-start - remarkPlugins: [math], - rehypePlugins: [katex], - // highlight-end - }, - }, - ], - ], - // highlight-start - stylesheets: [ - { - href: 'https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css', - integrity: - 'sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc', - crossorigin: 'anonymous', - }, - ], - // highlight-end -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-react.mdx deleted file mode 100644 index 8be1ae86fc..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/guides/markdown-features/markdown-features-react.mdx +++ /dev/null @@ -1,218 +0,0 @@ ---- -id: react -title: MDX and React -description: Using the power of React in Docusaurus Markdown documents, thanks to MDX -slug: /markdown-features/react ---- - -# MDX and React - -```mdx-code-block -import BrowserWindow from '@site/src/components/BrowserWindow'; -``` - -## Using JSX in Markdown {#using-jsx-in-markdown} - -Docusaurus has built-in support for [MDX v1](https://mdxjs.com/), which allows you to write JSX within your Markdown files and render them as React components. - -:::note - -While both `.md` and `.mdx` files are parsed using MDX, some of the syntax are treated slightly differently. For the most accurate parsing and better editor support, we recommend using the `.mdx` extension for files containing MDX syntax. - -::: - -:::caution - -MDX is not [100% compatible with CommonMark](https://github.com/facebook/docusaurus/issues/3018). - -Use the **[MDX playground](https://mdx-git-renovate-babel-monorepo-mdx.vercel.app/playground)** to ensure that your syntax is valid MDX. - -::: - -Try this block here: - -```jsx -export const Highlight = ({children, color}) => ( - - {children} - -); - -Docusaurus green and Facebook blue are my favorite colors. - -I can write **Markdown** alongside my _JSX_! -``` - -Notice how it renders both the markup from your React component and the Markdown syntax: - -```mdx-code-block -export const Highlight = ({children, color}) => ( - - {children} - -); - - - -Docusaurus green -{` `}and Facebook blue are my favorite colors. - -I can write **Markdown** alongside my _JSX_! - - -``` - -
- -You can also import your own components defined in other files or third-party components installed via npm! Check out the [MDX docs](https://mdxjs.com/) to see what other fancy stuff you can do with MDX. - -:::caution - -Since all doc files are parsed using MDX, any HTML is treated as JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects. This behavior is different from Docusaurus 1. See also [Migrating from v1 to v2](../../migration/migration-manual.md#convert-style-attributes-to-style-objects-in-mdx). - -::: - -## Importing code snippets {#importing-code-snippets} - -You can not only import a file containing a component definition, but also import any code file as raw text, and then insert it in a code block, thanks to [Webpack raw-loader](https://webpack.js.org/loaders/raw-loader/). In order to use `raw-loader`, first you need to install it in your project: - -```bash npm2yarn -npm install --save raw-loader -``` - -Now you can import code snippets from another file as it is: - - -```jsx title="myMarkdownFile.mdx" -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource from '!!raw-loader!./myComponent'; - -{MyComponentSource} -``` - - -```mdx-code-block -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource from '!!raw-loader!@site/src/pages/examples/_myComponent'; - - - -{MyComponentSource} - - - -
-``` - -You can also pass `title` prop to `CodeBlock` component in order to appear it as header above your codeblock: - -```jsx - - {MyComponentSource} - -``` - -:::note - -You have to use `` rather than the Markdown triple-backtick ` ``` `, because the latter will ship out any of its content as-is, but you want JSX to insert the imported text here. - -::: - -:::warning - -This feature is experimental and might be subject to API breaking changes in the future. - -::: - -## Importing Markdown {#importing-markdown} - -You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages. - -By convention, using the **`_` filename prefix** will not create any doc page and means the markdown file is a **"partial"**, to be imported by other files. - -```md title="_markdown-partial-example.mdx" -Hello {props.name} - -This is text some content from `_markdown-partial-example.mdx`. -``` - -```jsx title="someOtherDoc.mdx" -import PartialExample from './_markdown-partial-example.mdx'; - -; -``` - -```mdx-code-block -import PartialExample from './_markdown-partial-example.mdx'; - - - - - -
-``` - -This way, you can reuse contents among multiple pages and avoid duplicating materials. - -:::caution - -The table-of-contents does not currently contain the imported Markdown headings. This is a technical limitation that we are trying to solve ([issue](https://github.com/facebook/docusaurus/issues/3915)). - -::: - -## Available exports - -Within the MDX page, the following variables are available as globals: - -- `frontMatter`: the front matter as a record of string keys and values; -- `toc`: the table of contents, as a tree of headings. See also [Inline TOC](./markdown-features-inline-toc.mdx) for a more concrete use-case. -- `contentTitle`: the Markdown title, which is the first `h1` heading in the Markdown text. It's `undefined` if there isn't one (e.g. title specified in the front matter). - -```jsx -import TOCInline from '@theme/TOCInline'; -import CodeBlock from '@theme/CodeBlock'; - -The table of contents for this page, serialized: - -{JSON.stringify(toc, null, 2)} - -The front matter of this page: - -
    - {Object.entries(frontMatter).map(([key, value]) =>
  • {key}: {value}
    • )} -
- -

The title of this page is: {contentTitle}

-``` - -```mdx-code-block -import TOCInline from '@theme/TOCInline'; - - - -The table of contents for this page, serialized: - -{JSON.stringify(toc, null, 2)} - -The front matter of this page: - -
    - {Object.entries(frontMatter).map(([key, value]) =>
  • {key}: {value}
    • )} -
- -

The title of this page is: {contentTitle}

- - -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/i18n/i18n-tutorial.md b/website/versioned_docs/version-2.0.0-beta.13/i18n/i18n-tutorial.md deleted file mode 100644 index 4e4ce73ebd..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/i18n/i18n-tutorial.md +++ /dev/null @@ -1,336 +0,0 @@ ---- -id: tutorial -title: i18n - Tutorial -slug: /i18n/tutorial ---- - -This tutorial will walk you through the basis of the **Docusaurus i18n system**. - -We will add **French** translations to a **newly initialized English Docusaurus website**. - -Initialize a new site with `npx create-docusaurus@latest website classic` (like [this one](https://github.com/facebook/docusaurus/tree/main/examples/classic)). - -## Configure your site {#configure-your-site} - -Modify `docusaurus.config.js` to add the i18n support for the French language. - -### Site configuration {#site-configuration} - -Use the [site i18n configuration](./../api/docusaurus.config.js.md#i18n) to declare the i18n locales: - -```js title="docusaurus.config.js" -module.exports = { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -### Theme configuration {#theme-configuration} - -Add a **navbar item** of type `localeDropdown` so that users can select the locale they want: - -```js title="docusaurus.config.js" -module.exports = { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - position: 'left', - }, - // highlight-end - ], - }, - }, -}; -``` - -### Start your site {#start-your-site} - -Start your localized site in dev mode, using the locale of your choice: - -```bash npm2yarn -npm run start -- --locale fr -``` - -Your site is accessible at **`http://localhost:3000/fr/`**. - -We haven't provided any translation, and the site is **mostly untranslated**. - -:::tip - -Docusaurus provides **default translations** for generic theme labels, such as "Next" and "Previous" for the pagination. - -Please help us complete those **[default translations](https://github.com/facebook/docusaurus/tree/main/packages/docusaurus-theme-translations/locales)**. - -::: - -:::caution - -Each locale is a **distinct standalone single-page-application**: it is not possible to start the Docusaurus sites in all locales at the same time. - -::: - -## Translate your site {#translate-your-site} - -The French translations will be added in `website/i18n/fr`. - -Docusaurus is modular, and each content plugin has its own subfolder. - -:::note - -After copying files around, restart your site with `npm run start -- --locale fr`. - -Hot-reload will work better when editing existing files. - -::: - -### Use the translation APIs {#use-the-translation-apis} - -Open the homepage, and use the [translation APIs](../docusaurus-core.md#translate): - -```jsx title="src/pages/index.js" -import React from 'react'; -import Layout from '@theme/Layout'; -import Link from '@docusaurus/Link'; - -// highlight-start -import Translate, {translate} from '@docusaurus/Translate'; -// highlight-end - -export default function Home() { - return ( - -

- {/* highlight-start */} - Welcome to my website - {/* highlight-end */} -

-
- {/* highlight-start */} - blog}}> - {'You can also visit my {blog}'} - - {/* highlight-end */} - - -
- - ); -} -``` - -:::caution - -Docusaurus provides a **very small and lightweight translation runtime** on purpose, and only supports basic [placeholders interpolation](../docusaurus-core.md#interpolate), using a subset of the [ICU Message Format](https://formatjs.io/docs/core-concepts/icu-syntax/). - -Most documentation websites are generally **static** and don't need advanced i18n features (**plurals**, **genders**, etc.). Use a library like [react-intl](https://www.npmjs.com/package/react-intl) for more advanced use-cases. - -::: - -### Translate JSON files {#translate-json-files} - -JSON translation files are used for everything that is not contained in a Markdown document: - -- React/JSX code -- Layout navbar and footer labels -- Docs sidebar category labels -- ... - -Run the [write-translations](../cli.md#docusaurus-write-translations-sitedir) command: - -```bash npm2yarn -npm run write-translations -- --locale fr -``` - -It will extract and initialize the JSON translation files that you need to translate. - -The homepage translations are statically extracted from React source code: - -```json title="i18n/fr/code.json" -{ - "Welcome to my website": { - "message": "Welcome to my website", - "description": "The homepage welcome message" - }, - "Hello": { - "message": "Hello", - "description": "The homepage input placeholder" - } -} -``` - -Plugins and themes will also write their own **JSON translation files**, such as: - -```json title="i18n/fr/docusaurus-theme-classic/navbar.json" -{ - "title": { - "message": "My Site", - "description": "The title in the navbar" - }, - "item.label.Docs": { - "message": "Docs", - "description": "Navbar item with label Docs" - }, - "item.label.Blog": { - "message": "Blog", - "description": "Navbar item with label Blog" - }, - "item.label.GitHub": { - "message": "GitHub", - "description": "Navbar item with label GitHub" - } -} -``` - -Translate the `message` attribute in the JSON files of `i18n/fr`, and your site layout and homepage should now be translated. - -### Translate Markdown files {#translate-markdown-files} - -Official Docusaurus content plugins extensively use Markdown/MDX files, and allow you to translate them. - -#### Translate the docs {#translate-the-docs} - -Copy your docs Markdown files to `i18n/fr/docusaurus-plugin-content-docs/current`, and translate them: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current -cp -r docs/** i18n/fr/docusaurus-plugin-content-docs/current -``` - -:::info - -`current` is needed for the docs versioning feature: each docs version has its own subfolder. - -::: - -#### Translate the blog {#translate-the-blog} - -Copy your blog Markdown files to `i18n/fr/docusaurus-plugin-content-blog`, and translate them: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-blog -cp -r blog/** i18n/fr/docusaurus-plugin-content-blog -``` - -#### Translate the pages {#translate-the-pages} - -Copy your pages Markdown files to `i18n/fr/docusaurus-plugin-content-pages`, and translate them: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-pages -cp -r src/pages/**.md i18n/fr/docusaurus-plugin-content-pages -cp -r src/pages/**.mdx i18n/fr/docusaurus-plugin-content-pages -``` - -:::caution - -We only copy `.md` and `.mdx` files, as pages React components are translated through JSON translation files already. - -::: - -### Use explicit heading ids {#use-explicit-heading-ids} - -By default, a Markdown heading `### Hello World` will have a generated id `hello-world`. - -Other documents can target it with `[link](#hello-world)`. - -The translated heading becomes `### Bonjour le Monde`, with id `bonjour-le-monde`. - -Generated ids are not always a good fit for localized sites, as it requires you to localize all the anchor links: - -```diff -- [link](#hello-world). -+ [link](#bonjour-le-monde) -``` - -:::tip - -For localized sites, it is recommended to use **[explicit heading ids](../guides/markdown-features/markdown-features-headings.mdx#explicit-ids)**. - -::: - -## Deploy your site {#deploy-your-site} - -You can choose to deploy your site under a **single domain**, or use **multiple (sub)domains**. - -### Single-domain deployment {#single-domain-deployment} - -Run the following command: - -```bash npm2yarn -npm run build -``` - -Docusaurus will build **one single-page application per locale**: - -- `website/build`: for the default, English language -- `website/build/fr`: for the French language - -You can now [deploy](../deployment.mdx) the `build` folder to the static hosting solution of your choice. - -:::note - -The Docusaurus v2 website use this strategy: - -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) - -::: - -:::tip - -Static hosting providers generally redirect `/unknown/urls` to `/404.html` by convention, always showing an **English 404 page**. - -**Localize your 404 pages** by configuring your host to redirect `/fr/*` to `/fr/404.html`. - -This is not always possible, and depends on your host: GitHub Pages can't do this, [Netlify](https://docs.netlify.com/routing/redirects/redirect-options/#custom-404-page-handling) can. - -::: - -### Multi-domain deployment {#multi-domain-deployment} - -You can also build your site for a single locale: - -```bash npm2yarn -npm run build -- --locale fr -``` - -Docusaurus will not add the `/fr/` URL prefix. - -On your [static hosting provider](../deployment.mdx): - -- create one deployment per locale -- configure the appropriate build command, using the `--locale` option -- configure the (sub)domain of your choice for each deployment - -:::caution - -This strategy is **not possible** with Github Pages, as it is only possible to **have a single deployment**. - -::: - -### Hybrid {#hybrid} - -It is possible to have some locales using sub-paths, and others using subdomains. - -It is also possible to deploy each locale as a separate subdomain, assemble the subdomains in a single unified domain at the CDN level: - -- Deploy your site as `fr.docusaurus.io` -- Configure a CDN to serve it from `docusaurus.io/fr` diff --git a/website/versioned_docs/version-2.0.0-beta.13/presets.md b/website/versioned_docs/version-2.0.0-beta.13/presets.md deleted file mode 100644 index e359ca404b..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/presets.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -id: presets -title: Presets ---- - -Presets are collections of plugins and themes. - -## Using presets {#using-presets} - -A preset is usually a npm package, so you install them like other npm packages using npm. - -```bash npm2yarn -npm install --save @docusaurus/preset-classic -``` - -Then, add it in your site's `docusaurus.config.js`'s `presets` option: - -```jsx {3} title="docusaurus.config.js" -module.exports = { - // ... - presets: ['@docusaurus/preset-classic'], -}; -``` - -To load presets from your local directory, specify how to resolve them: - -```jsx {5} title="docusaurus.config.js" -const path = require('path'); - -module.exports = { - // ... - presets: [path.resolve(__dirname, '/path/to/docusaurus-local-presets')], -}; -``` - -## Presets -> themes and plugins {#presets---themes-and-plugins} - -Presets are a shorthand function to add plugins and themes to your Docusaurus config. For example, you can specify a preset that includes the following themes and plugins, - -```js -module.exports = function preset(context, opts = {}) { - return { - themes: ['@docusaurus/theme-cool', opts.cool], - plugins: ['@docusaurus/plugin-blog', opts.blog], - }; -}; -``` - -then in your Docusaurus config, you may configure the preset instead: - -```jsx {3} title="docusaurus.config.js" -module.exports = { - presets: [ - '@docusaurus/preset-my-own', - {cool: {hello: 'world'}, blog: {path: '/blog'}}, - ], -}; -``` - -This is equivalent of doing: - -```jsx title="docusaurus.config.js" -module.exports = { - themes: ['@docusaurus/themes-cool', {hello: 'world'}], - plugins: ['@docusaurus/plugin-blog', {path: '/blog'}], -}; -``` - -This is especially useful when some plugins and themes are intended to be used together. - -## Official presets {#official-presets} - -### `@docusaurus/preset-classic` {#docusauruspreset-classic} - -The classic preset that is usually shipped by default to new Docusaurus website. It is a set of plugins and themes. - -| Themes | Plugins | -| --- | --- | -| [`@docusaurus/theme-classic`](./api/themes/theme-configuration.md) | [`@docusaurus/plugin-content-docs`](./api/plugins/plugin-content-docs.md) | -| [`@docusaurus/theme-search-algolia`](./api/themes/theme-search-algolia.md) | [`@docusaurus/plugin-content-blog`](./api/plugins/plugin-content-blog.md) | -| | [`@docusaurus/plugin-content-pages`](./api/plugins/plugin-content-pages.md) | -| | [`@docusaurus/plugin-debug`](./api/plugins/plugin-debug.md) | -| | [`@docusaurus/plugin-google-analytics`](./api/plugins/plugin-google-analytics.md) | -| | [`@docusaurus/plugin-google-gtag`](./api/plugins/plugin-google-gtag.md) | -| | [`@docusaurus/plugin-sitemap`](./api/plugins/plugin-sitemap.md) | - -To specify plugin options individually, you can provide the necessary fields to certain plugins, i.e. `customCss` for `@docusaurus/theme-classic`, pass them in the preset field, like this: - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - // Debug defaults to true in dev, false in prod - debug: undefined, - // Will be passed to @docusaurus/theme-classic. - theme: { - customCss: [require.resolve('./src/css/custom.css')], - }, - // Will be passed to @docusaurus/plugin-content-docs (false to disable) - docs: {}, - // Will be passed to @docusaurus/plugin-content-blog (false to disable) - blog: {}, - // Will be passed to @docusaurus/plugin-content-pages (false to disable) - pages: {}, - // Will be passed to @docusaurus/plugin-content-sitemap (false to disable) - sitemap: {}, - // Will be passed to @docusaurus/plugin-google-gtag (only enabled when explicitly specified) - gtag: {}, - // Will be passed to @docusaurus/plugin-google-analytics (only enabled when explicitly specified) - googleAnalytics: {}, - }, - ], - ], -}; -``` - -In addition to these plugins and themes, `@docusaurus/theme-classic` adds [`remark-admonitions`](https://github.com/elviswolcott/remark-admonitions) as a remark plugin to `@docusaurus/plugin-content-blog` and `@docusaurus/plugin-content-docs`. - -The `admonitions` key will be passed as the [options](https://github.com/elviswolcott/remark-admonitions#options) to `remark-admonitions`. Passing `false` will prevent the plugin from being added to MDX. - -```js title="docusaurus.config.js" -module.exports = { - presets: [ - [ - '@docusaurus/preset-classic', - { - docs: { - // options for remark-admonitions - admonitions: {}, - }, - }, - ], - ], -}; -``` diff --git a/website/versioned_docs/version-2.0.0-beta.13/static-assets.md b/website/versioned_docs/version-2.0.0-beta.13/static-assets.md deleted file mode 100644 index b37f1c6b13..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/static-assets.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: static-assets -title: Static Assets ---- - -Every website needs assets: images, stylesheets, favicons etc. By default, you are suggested to put these assets in the `static` folder. - -Every file you put into **that directory will be copied** into the root of the generated `build` folder with the directory hierarchy preserved. E.g. if you add a file named `sun.jpg` to the static folder, it will be copied to `build/sun.jpg`. - -This means that: - -- for site `baseUrl: '/'`, the image `/static/img/docusaurus.png` will be served at `/img/docusaurus.png`. -- for site `baseUrl: '/subpath/'`, the image `/static/img/docusaurus.png` will be served at `/subpath/img/docusaurus.png`. - -You can customize the static directory sources in `docusaurus.config.js`. For example, we can add `public` as another possible path: - -```js title="docusaurus.config.js" -module.exports = { - title: 'My site', - staticDirectories: ['public', 'static'], - // ... -}; -``` - -Now, all files in `public` as well as `static` will be copied to the build output. - -## Referencing your static asset {#referencing-your-static-asset} - -In JSX, you can reference assets from the `static` folder in your code using absolute paths, but this is not ideal because changing the site `baseUrl` will **break those links**. For the image `` served at `https://example.com/test`, the browser will try to resolve it from the URL root, i.e. as `https://example.com/img/docusaurus.png`, which will fail because it's actually served at `https://example.com/test/img/docusaurus.png`. - -You can `import` / `require()` the static asset (recommended), or use the `useBaseUrl` utility function: both prepend the `baseUrl` to paths for you. - -:::info - -In Markdown, things are different: you can stick to use absolute paths because Docusaurus actually handles them as `require` calls instead of URLs when parsing the Markdown. See [Markdown static assets](./guides/markdown-features/markdown-features-assets.mdx). - -::: - -### Examples {#examples} - -```jsx title="MyComponent.js" -import DocusaurusImageUrl from '@site/static/img/docusaurus.png'; - -; -``` - -```jsx title="MyComponent.js" - -``` - -```jsx title="MyComponent.js" -import useBaseUrl from '@docusaurus/useBaseUrl'; - -; -``` - -You can also import SVG files: they will be transformed into React components. - -```jsx title="MyComponent.js" -import DocusaurusLogoWithKeytar from '@site/static/img/docusaurus_keytar.svg'; - -; -``` - -### Caveats {#caveats} - -Keep in mind that: - -- By default, none of the files in `static` folder will be post-processed, hashed or minified. -- Missing files referenced via hardcoded absolute paths will not be detected at compilation time, and will result in a 404 error. -- By default, GitHub Pages runs published files through [Jekyll](https://jekyllrb.com/). Since Jekyll will discard any files that begin with `_`, it is recommended that you disable Jekyll by adding an empty file named `.nojekyll` file to your `static` directory if you are using GitHub pages for hosting. diff --git a/website/versioned_docs/version-2.0.0-beta.13/using-plugins.md b/website/versioned_docs/version-2.0.0-beta.13/using-plugins.md deleted file mode 100644 index 745ff93adf..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/using-plugins.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -id: using-plugins -title: Plugins ---- - -Plugins are the building blocks of features in a Docusaurus 2 site. Each plugin handles its own individual feature. Plugins may work and be distributed as part of bundle via [presets](presets.md). - -## Available plugins {#available-plugins} - -We maintain a [list of official plugins](./api/plugins/overview.md), but the community has also created some [unofficial plugins](/community/resources#community-plugins). - -## Installing a plugin {#installing-a-plugin} - -A plugin is usually a npm package, so you install them like other npm packages using npm. - -```bash npm2yarn -npm install --save docusaurus-plugin-name -``` - -Then you add it in your site's `docusaurus.config.js`'s `plugins` option: - -```jsx {3} title="docusaurus.config.js" -module.exports = { - // ... - plugins: ['@docusaurus/plugin-content-pages'], -}; -``` - -Docusaurus can also load plugins from your local directory, you can do something like the following: - -```jsx {5} title="docusaurus.config.js" -const path = require('path'); - -module.exports = { - // ... - plugins: [path.resolve(__dirname, '/path/to/docusaurus-local-plugin')], -}; -``` - -## Configuring plugins {#configuring-plugins} - -For the most basic usage of plugins, you can provide just the plugin name or the absolute path to the plugin. - -However, plugins can have options specified by wrapping the name and an options object in an array inside your config. This style is usually called `Babel Style`. - -```js {4-9} title="docusaurus.config.js" -module.exports = { - // ... - plugins: [ - [ - '@docusaurus/plugin-xxx', - { - /* options */ - }, - ], - ], -}; -``` - -Example: - -```js title="docusaurus.config.js" -module.exports = { - plugins: [ - // Basic usage. - '@docusaurus/plugin-google-analytics', - - // With options object (babel style) - [ - '@docusaurus/plugin-sitemap', - { - changefreq: 'weekly', - }, - ], - ], -}; -``` - -## Multi-instance plugins and plugin ids {#multi-instance-plugins-and-plugin-ids} - -All Docusaurus content plugins can support multiple plugin instances. - -The Docs plugin has [additional multi-instance documentation](./guides/docs/docs-multi-instance.mdx) - -It is required to assign a unique id to each plugin instance. - -By default, the plugin id is `default`. - -```js {6,13} title="docusaurus.config.js" -module.exports = { - plugins: [ - [ - '@docusaurus/plugin-xxx', - { - id: 'plugin-xxx-1', - // other options - }, - ], - [ - '@docusaurus/plugin-xxx', - { - id: 'plugin-xxx-2', - // other options - }, - ], - ], -}; -``` - -:::note - -At most one plugin instance can be the "default plugin instance", by omitting the `id` attribute, or using `id: 'default'`. - -::: - -## Plugins design {#plugins-design} - -Docusaurus' implementation of the plugins system provides us with a convenient way to hook into the website's lifecycle to modify what goes on during development/build, which involves (but not limited to) extending the webpack config, modifying the data being loaded and creating new components to be used in a page. - -## Creating plugins {#creating-plugins} - -A plugin is a function that takes two parameters: `context` and `options`. - -It returns a plugin instance object, containing plugin [lifecycle APIs](./api/plugin-methods/README.md). - -It can be defined as a function or a module. - -### Functional definition {#functional-definition} - -You can use a plugin as a function, directly in the Docusaurus config file: - -```js title="docusaurus.config.js" -module.exports = { - // ... - plugins: [ - // highlight-start - function myPlugin(context, options) { - // ... - return { - name: 'my-plugin', - async loadContent() { - // ... - }, - async contentLoaded({content, actions}) { - // ... - }, - /* other lifecycle API */ - }; - }, - // highlight-end - ], -}; -``` - -### Module definition {#module-definition} - -You can use a plugin as a module, loading it from a separate file or NPM package: - -```js title="docusaurus.config.js" -module.exports = { - // ... - plugins: [ - // without options: - './my-plugin', - // or with options: - ['./my-plugin', options], - ], -}; -``` - -Then in the folder `my-plugin` you can create an index.js such as this - -```js title="my-plugin.js" -module.exports = function myPlugin(context, options) { - // ... - return { - name: 'my-plugin', - async loadContent() { - /* ... */ - }, - async contentLoaded({content, actions}) { - /* ... */ - }, - /* other lifecycle API */ - }; -}; -``` - -#### `context` {#context} - -`context` is plugin-agnostic, and the same object will be passed into all plugins used for a Docusaurus website. The `context` object contains the following fields: - -```ts -interface LoadContext { - siteDir: string; - generatedFilesDir: string; - siteConfig: DocusaurusConfig; - outDir: string; - baseUrl: string; -} -``` - -#### `options` {#options} - -`options` are the [second optional parameter when the plugins are used](using-plugins.md#configuring-plugins). `options` are plugin-specific and are specified by users when they use them in `docusaurus.config.js`. Alternatively, if preset contains the plugin, the preset will then be in charge of passing the correct options into the plugin. It is up to individual plugin to define what options it takes. - -#### Return value {#return-value} - -The returned object value should implement the [lifecycle APIs](./api/plugin-methods/README.md). diff --git a/website/versioned_docs/version-2.0.0-beta.13/using-themes.md b/website/versioned_docs/version-2.0.0-beta.13/using-themes.md deleted file mode 100644 index 129f95476b..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.13/using-themes.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -id: using-themes -title: Themes ---- - -Like plugins, themes are designed to add functionality to your Docusaurus site. As a good rule of thumb, themes are mostly focused on client-side, where plugins are more focused on server-side functionalities. Themes are also designed to be replace-able with other themes. - -## Available themes {#available-themes} - -We maintain a [list of official themes](./api/themes/overview.md). - -## Using themes {#using-themes} - -To use themes, specify the themes in your `docusaurus.config.js`. You may use multiple themes: - -```js {3} title="docusaurus.config.js" -module.exports = { - // ... - themes: ['@docusaurus/theme-classic', '@docusaurus/theme-live-codeblock'], -}; -``` - -## Theme components {#theme-components} - -Most of the time, theme is used to provide a set of React components, e.g. `Navbar`, `Layout`, `Footer`. - -Users can use these components in their code by importing them using the `@theme` webpack alias: - -```js -import Navbar from '@theme/Navbar'; -``` - -The alias `@theme` can refer to a few directories, in the following priority: - -1. A user's `website/src/theme` directory, which is a special directory that has the higher precedence. -1. A Docusaurus theme packages's `theme` directory. -1. Fallback components provided by Docusaurus core (usually not needed). - -Given the following structure - -``` -website -├── node_modules -│ └── docusaurus-theme -│ └── theme -│ └── Navbar.js -└── src - └── theme - └── Navbar.js -``` - -`website/src/theme/Navbar.js` takes precedence whenever `@theme/Navbar` is imported. This behavior is called component swizzling. In iOS, method swizzling is the process of changing the implementation of an existing selector (method). In the context of a website, component swizzling means providing an alternative component that takes precedence over the component provided by the theme. - -**Themes are for providing UI components to present the content.** Most content plugins need to be paired with a theme in order to be actually useful. The UI is a separate layer from the data schema, so it makes it easy to swap out the themes for other designs. - -For example, a Docusaurus blog consists of a blog plugin and a blog theme. - -```js title="docusaurus.config.js" -{ - theme: ['theme-blog'], - plugins: ['plugin-content-blog'], -} -``` - -And if you want to use Bootstrap styling, you can swap out the theme with `theme-blog-bootstrap` (fictitious non-existing theme): - -```js title="docusaurus.config.js" -{ - theme: ['theme-blog-bootstrap'], - plugins: ['plugin-content-blog'], -} -``` - -## Wrapping your site with `` {#wrapper-your-site-with-root} - -A `` theme component is rendered at the very top of your Docusaurus site. - -It allows you to wrap your site with additional logic, by creating a file at `src/theme/Root.js`: - -```js title="website/src/theme/Root.js" -import React from 'react'; - -// Default implementation, that you can customize -function Root({children}) { - return <>{children}; -} - -export default Root; -``` - -This component is applied above the router and the theme ``, and will **never unmount**. - -:::tip - -Use this component to render React Context providers and global stateful logic. - -::: - -## Swizzling theme components {#swizzling-theme-components} - -```mdx-code-block -import SwizzleWarning from "./_partials/swizzleWarning.mdx" - - -``` - -Docusaurus Themes' components are designed to be replaceable. To make it easier for you, we created a command for you to replace theme components called `swizzle`. - -To swizzle a component for a theme, run the following command in your doc site: - -```bash npm2yarn -npm run swizzle [component name] -``` - -As an example, to swizzle the `