mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-25 14:07:50 +02:00
docs: create Docusaurus v2.2.0 release docs + changelog + release blog post (#8265)
This commit is contained in:
parent
9f4d2e7136
commit
41c981aa9f
97 changed files with 18857 additions and 1 deletions
|
@ -6,7 +6,7 @@ tags: [release]
|
|||
image: ./img/social-card.png
|
||||
---
|
||||
|
||||
We are happy announce **Docusaurus 2.1**, our very first minor version release.
|
||||
We are happy to announce **Docusaurus 2.1**, our very first minor version release.
|
||||
|
||||
The upgrade should be easy: as explained in our [release process documentation](/community/release-process), minor versions respect [Semantic Versioning](https://semver.org/).
|
||||
|
||||
|
|
BIN
website/blog/releases/2.2/img/social-card.png
Normal file
BIN
website/blog/releases/2.2/img/social-card.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 156 KiB |
123
website/blog/releases/2.2/index.mdx
Normal file
123
website/blog/releases/2.2/index.mdx
Normal file
|
@ -0,0 +1,123 @@
|
|||
---
|
||||
title: Docusaurus 2.2
|
||||
authors: [slorber]
|
||||
tags: [release]
|
||||
image: ./img/social-card.png
|
||||
date: 2022-10-29
|
||||
---
|
||||
|
||||
We are happy to announce **Docusaurus 2.2**.
|
||||
|
||||
The upgrade should be easy: as explained in our [release process documentation](/community/release-process), minor versions respect [Semantic Versioning](https://semver.org/).
|
||||
|
||||

|
||||
|
||||
<!--truncate-->
|
||||
|
||||
## Highlights
|
||||
|
||||
### Mermaid diagrams
|
||||
|
||||
In [#7490](https://github.com/facebook/docusaurus/pull/7490), we added support for Mermaid diagrams. This fills the gap between GitHub Flavored Markdown which also [added support recently](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/). You can create Mermaid diagrams using Markdown code blocks:
|
||||
|
||||
````md
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Health check
|
||||
John->>John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail!
|
||||
John-->>Alice: Great!
|
||||
John->>Bob: How about you?
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
````
|
||||
|
||||
````mdx-code-block
|
||||
import BrowserWindow from '@site/src/components/BrowserWindow';
|
||||
|
||||
<BrowserWindow>
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Alice
|
||||
participant Bob
|
||||
Alice->>John: Hello John, how are you?
|
||||
loop Health check
|
||||
John->>John: Fight against hypochondria
|
||||
end
|
||||
Note right of John: Rational thoughts <br/>prevail!
|
||||
John-->>Alice: Great!
|
||||
John->>Bob: How about you?
|
||||
Bob-->>John: Jolly good!
|
||||
```
|
||||
|
||||
</BrowserWindow>
|
||||
|
||||
````
|
||||
|
||||
Make sure to check the [documentation](/docs/markdown-features/diagrams), and the [more advanced examples](/tests/pages/diagrams)
|
||||
|
||||
### Config `headTags`
|
||||
|
||||
In [#8151](https://github.com/facebook/docusaurus/pull/8151), we added the ability to apply arbitrary HTML `<head>` tags to all pages of your site.
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
headTags: [
|
||||
{
|
||||
tagName: 'link',
|
||||
attributes: {
|
||||
rel: 'icon',
|
||||
href: '/img/docusaurus.png',
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
|
||||
### Accessibility
|
||||
|
||||
We did several accessibility improvements:
|
||||
|
||||
- [#8207](https://github.com/facebook/docusaurus/pull/8207): improves keyboard navigation for mobile drawer hamburger button
|
||||
- [#8161](https://github.com/facebook/docusaurus/pull/8161): improves keyboard navigation for tabs
|
||||
- [#8204](https://github.com/facebook/docusaurus/pull/8204): makes the skip to content button support progressive enhancement
|
||||
- [#8174](https://github.com/facebook/docusaurus/pull/8174): improves screen reader announcement when toggling between light/dark mode
|
||||
|
||||
### Developer Experience
|
||||
|
||||
We made validation stricter and improved error messages:
|
||||
|
||||
- [#8234](https://github.com/facebook/docusaurus/pull/8234): in case of doc processing failure, prints the problematic markdown file path in the error message
|
||||
- [#8192](https://github.com/facebook/docusaurus/pull/8192) and [#8159](https://github.com/facebook/docusaurus/pull/8159): validates `siteConfig.url` more strictly and with better error message
|
||||
- [#8066](https://github.com/facebook/docusaurus/pull/8066): makes config `url` and `baseUrl` fail-safe and less sensitive to the presence or absence of a leading or trailing slash
|
||||
|
||||
### Translations
|
||||
|
||||
We completed the default theme translation support for multiple languages:
|
||||
|
||||
- 🇹🇷 [#8105](https://github.com/facebook/docusaurus/pull/8105): completes Turkish translations
|
||||
- 🇷🇺 [#8253](https://github.com/facebook/docusaurus/pull/8253): completes Russian translations
|
||||
- 🇫🇷 [#8243](https://github.com/facebook/docusaurus/pull/8243): completes French translations
|
||||
- 🇯🇵 [#8075](https://github.com/facebook/docusaurus/pull/8075): completes Japanese translations
|
||||
|
||||
:::tip
|
||||
|
||||
Completing theme translations is an [ongoing effort](https://github.com/facebook/docusaurus/issues/3526) and an easy way to contribute to Docusaurus. We add new theme features regularly, for which we often [need new translations](https://github.com/facebook/docusaurus/issues/3526).
|
||||
|
||||
:::
|
||||
|
||||
## Other changes
|
||||
|
||||
Other notable changes include:
|
||||
|
||||
- [#8210](https://github.com/facebook/docusaurus/pull/8210): the `docusaurus swizzle` CLI has a new `--config` option
|
||||
- [#8109](https://github.com/facebook/docusaurus/pull/8109): mobile navigation performance optimizations, prefetch resources earlier
|
||||
- [#8059](https://github.com/facebook/docusaurus/pull/8059): versions/locales navbar dropdowns preserve hash and querystring on navigation
|
||||
- [#8227](https://github.com/facebook/docusaurus/pull/8227): the client redirect plugin preserves hash and querystring on redirect
|
||||
|
||||
Check the **[2.2.0 changelog entry](/changelog/2.2.0)** for an exhaustive list of changes.
|
Loading…
Add table
Add a link
Reference in a new issue