diff --git a/CHANGELOG.md b/CHANGELOG.md index 7eee4e1962b7..9992b28ec895 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,80 @@ # Docusaurus 2 Changelog +## 2.0.0-beta.17 (2022-03-03) + +#### :rocket: New Feature + +- `docusaurus-plugin-content-blog`, `docusaurus-theme-classic` + - [#6783](https://github.com/facebook/docusaurus/pull/6783) feat: allow blog authors email ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :boom: Breaking Change + +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#6771](https://github.com/facebook/docusaurus/pull/6771) refactor(theme-classic): replace color mode toggle with button; remove switchConfig ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :bug: Bug Fix + +- `docusaurus-theme-classic` + - [#6827](https://github.com/facebook/docusaurus/pull/6827) fix(theme-classic): restore docusaurus search meta ([@slorber](https://github.com/slorber)) + - [#6767](https://github.com/facebook/docusaurus/pull/6767) fix(theme-classic): allow code tags containing inline elements to stay inline ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-common` + - [#6824](https://github.com/facebook/docusaurus/pull/6824) fix(theme-common): breadcrumbs home bug in docs-only ([@slorber](https://github.com/slorber)) + - [#6816](https://github.com/facebook/docusaurus/pull/6816) fix(theme-common): docs breadcrumbs not working with baseUrl ([@slorber](https://github.com/slorber)) +- `docusaurus-plugin-content-docs` + - [#6700](https://github.com/facebook/docusaurus/pull/6700) fix(content-docs): always sort autogenerated sidebar items by file/folder name by default ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus` + - [#6812](https://github.com/facebook/docusaurus/pull/6812) fix(core): remove hash/query when filtering existing files for broken link check ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader` + - [#6779](https://github.com/facebook/docusaurus/pull/6779) fix(mdx-loader): suppress image reading warning in Yarn PnP; log warning instead of error ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#6762](https://github.com/facebook/docusaurus/pull/6762) fix(create): update broken SVG paths in templates ([@anicholls](https://github.com/anicholls)) + +#### :nail_care: Polish + +- `docusaurus-theme-common` + - [#6826](https://github.com/facebook/docusaurus/pull/6826) refactor(theme-common): unify missing context errors ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic`, `docusaurus-theme-common` + - [#6771](https://github.com/facebook/docusaurus/pull/6771) refactor(theme-classic): replace color mode toggle with button; remove switchConfig ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-theme-classic` + - [#6769](https://github.com/facebook/docusaurus/pull/6769) refactor(theme-classic): use Material icon for language dropdown ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-mdx-loader` + - [#6792](https://github.com/facebook/docusaurus/pull/6792) fix(mdx-loader): allow image paths to be URL encoded ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :memo: Documentation + +- Other + - [#6825](https://github.com/facebook/docusaurus/pull/6825) docs: Adds Netlify one click deploy to README ([@PatelN123](https://github.com/PatelN123)) + - [#6818](https://github.com/facebook/docusaurus/pull/6818) docs: add deploy with vercel button to README ([@PatelN123](https://github.com/PatelN123)) + - [#6817](https://github.com/facebook/docusaurus/pull/6817) docs: fix broken links ([@PatelN123](https://github.com/PatelN123)) + - [#6811](https://github.com/facebook/docusaurus/pull/6811) docs: add homepage banner in support of Ukraine ([@dmitryvinn](https://github.com/dmitryvinn)) + - [#6813](https://github.com/facebook/docusaurus/pull/6813) docs: mark dyte as opensource in showcase ([@vaibhavshn](https://github.com/vaibhavshn)) + - [#6776](https://github.com/facebook/docusaurus/pull/6776) docs: make GitHub actions explanation aligned with the code ([@arifszn](https://github.com/arifszn)) + - [#6772](https://github.com/facebook/docusaurus/pull/6772) docs: add basic documentation about client modules ([@Josh-Cena](https://github.com/Josh-Cena)) +- `create-docusaurus` + - [#6815](https://github.com/facebook/docusaurus/pull/6815) fix: consistently use `max-width: 996px` in media queries ([@dstotijn](https://github.com/dstotijn)) + +#### :house: Internal + +- `docusaurus-plugin-content-docs` + - [#6821](https://github.com/facebook/docusaurus/pull/6821) test(content-docs): refactor navigation test snapshot ([@Josh-Cena](https://github.com/Josh-Cena)) +- Other + - [#6768](https://github.com/facebook/docusaurus/pull/6768) test: add TypeScript template to E2E test matrix ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-utils` + - [#6773](https://github.com/facebook/docusaurus/pull/6773) refactor(utils): categorize functions into separate files ([@Josh-Cena](https://github.com/Josh-Cena)) +- `docusaurus-migrate` + - [#6761](https://github.com/facebook/docusaurus/pull/6761) chore: various internal fixes ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### Committers: 8 + +- Alex Nicholls ([@anicholls](https://github.com/anicholls)) +- Ariful Alam ([@arifszn](https://github.com/arifszn)) +- David Stotijn ([@dstotijn](https://github.com/dstotijn)) +- Dmitry Vinnik ([@dmitryvinn](https://github.com/dmitryvinn)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Nayan Patel ([@PatelN123](https://github.com/PatelN123)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) +- Vaibhav Shinde ([@vaibhavshn](https://github.com/vaibhavshn)) + ## 2.0.0-beta.16 (2022-02-25) #### :rocket: New Feature diff --git a/website/versioned_docs/version-2.0.0-beta.15/_partials/swizzleWarning.mdx b/website/versioned_docs/version-2.0.0-beta.15/_partials/swizzleWarning.mdx deleted file mode 100644 index e2aec479dd28..000000000000 --- a/website/versioned_docs/version-2.0.0-beta.15/_partials/swizzleWarning.mdx +++ /dev/null @@ -1,5 +0,0 @@ -:::caution - -We discourage swizzling of components during the Docusaurus 2 beta phase. The theme components APIs are likely to evolve and have breaking changes. If possible, stick with the default appearance for now. - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.15/advanced/swizzling.md b/website/versioned_docs/version-2.0.0-beta.15/advanced/swizzling.md deleted file mode 100644 index 4163bb6e632b..000000000000 --- a/website/versioned_docs/version-2.0.0-beta.15/advanced/swizzling.md +++ /dev/null @@ -1,195 +0,0 @@ ---- -description: Customize your site's appearance through creating your own theme components ---- - -# Swizzling - -In this section, we will introduce how customization of layout is done in Docusaurus. - -> Déja vu...? - -This section is similar to [Styling and Layout](../styling-layout.md), but this time, we are going to write more code and go deeper into the internals instead of playing with stylesheets. We will talk about a central concept in Docusaurus customization: **swizzling**, from how to swizzle, to how it works under the hood. - -We know you are busy, so we will start with the "how" before going into the "why". - -## Swizzling - -```mdx-code-block -import SwizzleWarning from "../_partials/swizzleWarning.mdx" - - -``` - -Docusaurus Themes' components are designed to be replaceable. The replacing is called "swizzle". In Objective C, 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.** (To gain a deeper understanding of this, you have to understand [how theme components are resolved](#theme-aliases)). To help you get started, we created a command called `docusaurus swizzle`. - -### Ejecting theme components - -To eject a component provided by the theme, run the following command in your doc site: - -```bash npm2yarn -npm run swizzle [theme name] [component name] -``` - -As an example, to swizzle the `