From 97caab16d44fefe3a0a27eb55f3d0535f74b7a85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Thu, 23 Mar 2023 19:32:09 +0100 Subject: [PATCH] docs: create Docusaurus v2.4.0 release docs + changelog + release blog post (#8811) --- CHANGELOG.md | 64 + project-words.txt | 1 + website/_dogfooding/_pages tests/embeds.tsx | 27 +- .../blog/releases/2.4/img/navbar-error.jpg | Bin 0 -> 100926 bytes .../2.4/img/sidebar-item-description.jpg | Bin 0 -> 49227 bytes website/blog/releases/2.4/img/social-card.png | Bin 0 -> 159881 bytes website/blog/releases/2.4/index.mdx | 161 +++ website/docusaurus.config.js | 1 + .../components/BrowserWindow/IframeWindow.tsx | 33 + .../src/components/BrowserWindow/index.tsx | 14 + .../ErrorBoundaryTestButton/index.tsx | 13 +- .../version-2.4.0/advanced/architecture.mdx | 28 + .../version-2.4.0/advanced/client.mdx | 186 +++ .../version-2.4.0/advanced/index.mdx | 11 + .../version-2.4.0/advanced/plugins.mdx | 129 ++ .../version-2.4.0/advanced/routing.mdx | 296 +++++ .../version-2.4.0/advanced/ssg.mdx | 218 ++++ .../api/docusaurus.config.js.mdx | 598 +++++++++ .../version-2.4.0/api/misc/_category_.yml | 2 + .../api/misc/create-docusaurus.mdx | 58 + .../api/misc/eslint-plugin/README.mdx | 72 ++ .../eslint-plugin/no-untranslated-text.mdx | 54 + .../string-literal-i18n-messages.mdx | 50 + .../version-2.4.0/api/misc/logger/demo.png | Bin 0 -> 94456 bytes .../version-2.4.0/api/misc/logger/logger.mdx | 69 ++ .../api/plugin-methods/README.mdx | 146 +++ .../api/plugin-methods/_category_.yml | 2 + .../plugin-methods/extend-infrastructure.mdx | 135 ++ .../api/plugin-methods/i18n-lifecycles.mdx | 121 ++ .../api/plugin-methods/lifecycle-apis.mdx | 420 +++++++ .../api/plugin-methods/static-methods.mdx | 123 ++ .../version-2.4.0/api/plugins/_category_.yml | 5 + .../version-2.4.0/api/plugins/overview.mdx | 30 + .../api/plugins/plugin-client-redirects.mdx | 127 ++ .../api/plugins/plugin-content-blog.mdx | 290 +++++ .../api/plugins/plugin-content-docs.mdx | 365 ++++++ .../api/plugins/plugin-content-pages.mdx | 101 ++ .../api/plugins/plugin-debug.mdx | 108 ++ .../api/plugins/plugin-google-analytics.mdx | 77 ++ .../api/plugins/plugin-google-gtag.mdx | 73 ++ .../api/plugins/plugin-google-tag-manager.mdx | 70 ++ .../api/plugins/plugin-ideal-image.mdx | 83 ++ .../version-2.4.0/api/plugins/plugin-pwa.mdx | 303 +++++ .../api/plugins/plugin-sitemap.mdx | 82 ++ .../version-2.4.0/api/themes/_category_.yml | 5 + .../version-2.4.0/api/themes/overview.mdx | 34 + .../api/themes/theme-classic.mdx | 63 + .../api/themes/theme-configuration.mdx | 1086 +++++++++++++++++ .../api/themes/theme-live-codeblock.mdx | 29 + .../api/themes/theme-search-algolia.mdx | 20 + .../docusaurus-asset-example-banner.png | Bin 0 -> 69264 bytes .../assets/docusaurus-asset-example.docx | Bin 0 -> 6114 bytes .../assets/docusaurus-asset-example.xyz | Bin 0 -> 125786 bytes website/versioned_docs/version-2.4.0/blog.mdx | 658 ++++++++++ .../version-2.4.0/browser-support.mdx | 106 ++ website/versioned_docs/version-2.4.0/cli.mdx | 185 +++ .../version-2.4.0/configuration.mdx | 182 +++ .../version-2.4.0/deployment.mdx | 809 ++++++++++++ .../version-2.4.0/docusaurus-core.mdx | 727 +++++++++++ .../version-2.4.0/guides/creating-pages.mdx | 140 +++ .../guides/docs/docs-create-doc.mdx | 162 +++ .../guides/docs/docs-introduction.mdx | 116 ++ .../guides/docs/docs-multi-instance.mdx | 213 ++++ .../guides/docs/sidebar/autogenerated.mdx | 497 ++++++++ .../guides/docs/sidebar/index.mdx | 209 ++++ .../guides/docs/sidebar/items.mdx | 619 ++++++++++ .../guides/docs/sidebar/multiple-sidebars.mdx | 144 +++ .../version-2.4.0/guides/docs/versioning.mdx | 298 +++++ .../_markdown-partial-example.mdx | 3 + .../markdown-features-admonitions.mdx | 256 ++++ .../markdown-features-assets.mdx | 234 ++++ .../markdown-features-code-blocks.mdx | 848 +++++++++++++ .../markdown-features-diagrams.mdx | 85 ++ .../markdown-features-head-metadata.mdx | 82 ++ .../markdown-features-intro.mdx | 141 +++ .../markdown-features-links.mdx | 52 + .../markdown-features-math-equations.mdx | 210 ++++ .../markdown-features-plugins.mdx | 215 ++++ .../markdown-features-react.mdx | 579 +++++++++ .../markdown-features-react.module.css | 17 + .../markdown-features-tabs-styles.module.css | 30 + .../markdown-features-tabs.mdx | 380 ++++++ .../markdown-features-toc.mdx | 283 +++++ .../version-2.4.0/guides/whats-next.mdx | 21 + .../version-2.4.0/i18n/i18n-crowdin.mdx | 516 ++++++++ .../version-2.4.0/i18n/i18n-git.mdx | 181 +++ .../version-2.4.0/i18n/i18n-introduction.mdx | 137 +++ .../version-2.4.0/i18n/i18n-tutorial.mdx | 517 ++++++++ .../version-2.4.0/installation.mdx | 188 +++ .../version-2.4.0/introduction.mdx | 205 ++++ .../migration/migration-automated.mdx | 75 ++ .../migration/migration-manual.mdx | 634 ++++++++++ .../migration/migration-overview.mdx | 105 ++ .../migration/migration-translated-sites.mdx | 167 +++ .../migration/migration-versioned-sites.mdx | 176 +++ .../version-2.4.0/playground.mdx | 24 + .../versioned_docs/version-2.4.0/search.mdx | 315 +++++ website/versioned_docs/version-2.4.0/seo.mdx | 161 +++ .../version-2.4.0/static-assets.mdx | 109 ++ .../version-2.4.0/styling-layout.mdx | 267 ++++ .../version-2.4.0/swizzling.mdx | 328 +++++ .../version-2.4.0/typescript-support.mdx | 131 ++ .../version-2.4.0/using-plugins.mdx | 307 +++++ .../version-2.4.0-sidebars.json | 151 +++ website/versions.json | 1 + 105 files changed, 19157 insertions(+), 22 deletions(-) create mode 100644 website/blog/releases/2.4/img/navbar-error.jpg create mode 100644 website/blog/releases/2.4/img/sidebar-item-description.jpg create mode 100644 website/blog/releases/2.4/img/social-card.png create mode 100644 website/blog/releases/2.4/index.mdx create mode 100644 website/src/components/BrowserWindow/IframeWindow.tsx create mode 100644 website/versioned_docs/version-2.4.0/advanced/architecture.mdx create mode 100644 website/versioned_docs/version-2.4.0/advanced/client.mdx create mode 100644 website/versioned_docs/version-2.4.0/advanced/index.mdx create mode 100644 website/versioned_docs/version-2.4.0/advanced/plugins.mdx create mode 100644 website/versioned_docs/version-2.4.0/advanced/routing.mdx create mode 100644 website/versioned_docs/version-2.4.0/advanced/ssg.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/docusaurus.config.js.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/misc/_category_.yml create mode 100644 website/versioned_docs/version-2.4.0/api/misc/create-docusaurus.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/misc/eslint-plugin/README.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/misc/eslint-plugin/no-untranslated-text.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/misc/eslint-plugin/string-literal-i18n-messages.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/misc/logger/demo.png create mode 100644 website/versioned_docs/version-2.4.0/api/misc/logger/logger.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/README.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/_category_.yml create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/extend-infrastructure.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/i18n-lifecycles.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/lifecycle-apis.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugin-methods/static-methods.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/_category_.yml create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/overview.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-client-redirects.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-content-blog.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-content-docs.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-content-pages.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-debug.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-google-analytics.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-google-gtag.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-google-tag-manager.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-ideal-image.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-pwa.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/plugins/plugin-sitemap.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/themes/_category_.yml create mode 100644 website/versioned_docs/version-2.4.0/api/themes/overview.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/themes/theme-classic.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/themes/theme-configuration.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/themes/theme-live-codeblock.mdx create mode 100644 website/versioned_docs/version-2.4.0/api/themes/theme-search-algolia.mdx create mode 100644 website/versioned_docs/version-2.4.0/assets/docusaurus-asset-example-banner.png create mode 100644 website/versioned_docs/version-2.4.0/assets/docusaurus-asset-example.docx create mode 100644 website/versioned_docs/version-2.4.0/assets/docusaurus-asset-example.xyz create mode 100644 website/versioned_docs/version-2.4.0/blog.mdx create mode 100644 website/versioned_docs/version-2.4.0/browser-support.mdx create mode 100644 website/versioned_docs/version-2.4.0/cli.mdx create mode 100644 website/versioned_docs/version-2.4.0/configuration.mdx create mode 100644 website/versioned_docs/version-2.4.0/deployment.mdx create mode 100644 website/versioned_docs/version-2.4.0/docusaurus-core.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/creating-pages.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/docs-create-doc.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/docs-introduction.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/docs-multi-instance.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/sidebar/autogenerated.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/sidebar/index.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/sidebar/items.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/sidebar/multiple-sidebars.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/docs/versioning.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/_markdown-partial-example.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-admonitions.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-assets.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-code-blocks.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-diagrams.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-head-metadata.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-intro.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-links.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-math-equations.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-plugins.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-react.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-react.module.css create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-tabs-styles.module.css create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-tabs.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/markdown-features/markdown-features-toc.mdx create mode 100644 website/versioned_docs/version-2.4.0/guides/whats-next.mdx create mode 100644 website/versioned_docs/version-2.4.0/i18n/i18n-crowdin.mdx create mode 100644 website/versioned_docs/version-2.4.0/i18n/i18n-git.mdx create mode 100644 website/versioned_docs/version-2.4.0/i18n/i18n-introduction.mdx create mode 100644 website/versioned_docs/version-2.4.0/i18n/i18n-tutorial.mdx create mode 100644 website/versioned_docs/version-2.4.0/installation.mdx create mode 100644 website/versioned_docs/version-2.4.0/introduction.mdx create mode 100644 website/versioned_docs/version-2.4.0/migration/migration-automated.mdx create mode 100644 website/versioned_docs/version-2.4.0/migration/migration-manual.mdx create mode 100644 website/versioned_docs/version-2.4.0/migration/migration-overview.mdx create mode 100644 website/versioned_docs/version-2.4.0/migration/migration-translated-sites.mdx create mode 100644 website/versioned_docs/version-2.4.0/migration/migration-versioned-sites.mdx create mode 100644 website/versioned_docs/version-2.4.0/playground.mdx create mode 100644 website/versioned_docs/version-2.4.0/search.mdx create mode 100644 website/versioned_docs/version-2.4.0/seo.mdx create mode 100644 website/versioned_docs/version-2.4.0/static-assets.mdx create mode 100644 website/versioned_docs/version-2.4.0/styling-layout.mdx create mode 100644 website/versioned_docs/version-2.4.0/swizzling.mdx create mode 100644 website/versioned_docs/version-2.4.0/typescript-support.mdx create mode 100644 website/versioned_docs/version-2.4.0/using-plugins.mdx create mode 100644 website/versioned_sidebars/version-2.4.0-sidebars.json diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f224752ad..50ed28f83b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,69 @@ # Docusaurus 2 Changelog +## 2.4.0 (2023-03-23) + +#### :rocket: New Feature + +- `docusaurus-plugin-content-docs`, `docusaurus-theme-classic` + - [#8236](https://github.com/facebook/docusaurus/pull/8236) feat(content-docs): add support for sidebar item category/link descriptions in generated index page ([@ZarakiKanzaki](https://github.com/ZarakiKanzaki)) +- `docusaurus-theme-classic` + - [#8708](https://github.com/facebook/docusaurus/pull/8708) feat(theme): allow to load a Docusaurus page with theme from query-string: ?docusaurus-theme=dark ([@slorber](https://github.com/slorber)) + - [#8616](https://github.com/facebook/docusaurus/pull/8616) feat(theme): add ability to translate navbar+footer logo alt text ([@Mysterious-Dev](https://github.com/Mysterious-Dev)) +- `docusaurus-remark-plugin-npm2yarn` + - [#8690](https://github.com/facebook/docusaurus/pull/8690) feat(npm-to-yarn): add support for PnPm and custom converters ([@armano2](https://github.com/armano2)) +- `docusaurus` + - [#8677](https://github.com/facebook/docusaurus/pull/8677) feat(core): add script env variables: NODE_ENV + BABEL_ENV + DOCUSAURUS_CURRENT_LOCALE (temporary i18n workaround) ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#8674](https://github.com/facebook/docusaurus/pull/8674) feat(theme-classic): respect `prefers-reduced-motion: reduce` mediaquery, bump Infima to alpha.43 ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-translations` + - [#8668](https://github.com/facebook/docusaurus/pull/8668) feat(theme-translations): add Hungarian theme translations ([@trueqap](https://github.com/trueqap)) + - [#8631](https://github.com/facebook/docusaurus/pull/8631) feat(theme-translations): add Norwegian (Bokmål) theme translation ([@dr0nn1](https://github.com/dr0nn1)) +- `docusaurus-theme-common` + - [#8656](https://github.com/facebook/docusaurus/pull/8656) feat(theme-common): allow passing a string for details summary ([@pReya](https://github.com/pReya)) +- `docusaurus-plugin-google-gtag` + - [#8620](https://github.com/facebook/docusaurus/pull/8620) feat(gtag-plugin): gtag should support multiple tracking ids, notably for the UA => GA4 transition ([@slorber](https://github.com/slorber)) + +#### :bug: Bug Fix + +- `docusaurus-theme-classic` + - [#8803](https://github.com/facebook/docusaurus/pull/8803) fix(theme): codeblock buttons should be kept on the right when using RTL locale ([@Vishruta-Patil](https://github.com/Vishruta-Patil)) + - [#8615](https://github.com/facebook/docusaurus/pull/8615) fix(theme): improve color toggle when using dark navbar ([@dewanshDT](https://github.com/dewanshDT)) + - [#8699](https://github.com/facebook/docusaurus/pull/8699) fix(theme-classic): fix tab focus bug in dropdown (#8697) ([@kagankan](https://github.com/kagankan)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#8801](https://github.com/facebook/docusaurus/pull/8801) fix(theme): allow tabs children to be falsy ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-common`, `docusaurus-theme-search-algolia` + - [#8757](https://github.com/facebook/docusaurus/pull/8757) fix(search): search page should react to querystring changes + cleanup/refactor ([@slorber](https://github.com/slorber)) +- `docusaurus` + - [#8746](https://github.com/facebook/docusaurus/pull/8746) fix(core): baseUrl error banner link anchor case ([@slorber](https://github.com/slorber)) +- `docusaurus-theme-translations` + - [#8744](https://github.com/facebook/docusaurus/pull/8744) fix(theme-translations): fix wrong arabic words (tip/next) ([@Anasqx](https://github.com/Anasqx)) + +#### :nail_care: Polish + +- `create-docusaurus` + - [#8712](https://github.com/facebook/docusaurus/pull/8712) polish(create-docusaurus): the starter template should use a navbar item "docSidebar" instead of "doc" (less fragile on updates) ([@biplavmz](https://github.com/biplavmz)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus-utils-common`, `docusaurus` + - [#8735](https://github.com/facebook/docusaurus/pull/8735) polish(theme): better error messages on navbar item rendering failures + ErrorCauseBoundary API ([@tannerdolby](https://github.com/tannerdolby)) +- `docusaurus-theme-classic`, `docusaurus-theme-common`, `docusaurus` + - [#8736](https://github.com/facebook/docusaurus/pull/8736) polish(core): better styling for error screens ([@tannerdolby](https://github.com/tannerdolby)) + +#### Committers: 14 + +- Anas ([@Anasqx](https://github.com/Anasqx)) +- Armano ([@armano2](https://github.com/armano2)) +- Davide Donadio ([@ZarakiKanzaki](https://github.com/ZarakiKanzaki)) +- Dewansh Thakur ([@dewanshDT](https://github.com/dewanshDT)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Kagan ([@kagankan](https://github.com/kagankan)) +- Moritz Stückler ([@pReya](https://github.com/pReya)) +- Mysterious_Dev ([@Mysterious-Dev](https://github.com/Mysterious-Dev)) +- Petter Drønnen ([@dr0nn1](https://github.com/dr0nn1)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- Tanner Dolby ([@tannerdolby](https://github.com/tannerdolby)) +- TrueQAP ([@trueqap](https://github.com/trueqap)) +- Vishruta Patil ([@Vishruta-Patil](https://github.com/Vishruta-Patil)) +- [@biplavmz](https://github.com/biplavmz) + ## 2.3.1 (2023-02-03) #### :bug: Bug Fix diff --git a/project-words.txt b/project-words.txt index 983d0f16b0..106f7768d0 100644 --- a/project-words.txt +++ b/project-words.txt @@ -25,6 +25,7 @@ beforeinstallprompt bhatt blocklist blockquotes +Bokmål browserslist browserstack buble diff --git a/website/_dogfooding/_pages tests/embeds.tsx b/website/_dogfooding/_pages tests/embeds.tsx index 36bc066688..562e9f59dd 100644 --- a/website/_dogfooding/_pages tests/embeds.tsx +++ b/website/_dogfooding/_pages tests/embeds.tsx @@ -8,20 +8,7 @@ import React from 'react'; import Layout from '@theme/Layout'; import Heading from '@theme/Heading'; -import BrowserWindow from '@site/src/components/BrowserWindow'; - -function IframeTest({url}: {url: string}) { - return ( -
- -