docs(v2): Docusaurus 2 beta blog post (#4756)
* draft * draft * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * update draft * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-11-releasing-docusaurus-beta.md * update draft post * link to testimonials collection * remove alpha mention in doc * Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> * Update website-1.x/blog/2021-05-12-announcing-docusaurus-two-beta.md Co-authored-by: Joel Marcey <joelm@fb.com> Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Co-authored-by: Joel Marcey <joelm@fb.com>
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
|||
tags: [hello, docusaurus]
|
||||
---
|
||||
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
|||
tags: [hello, docusaurus]
|
||||
---
|
||||
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4
|
|||
tags: [hello, docusaurus]
|
||||
---
|
||||
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
|
|
|
@ -0,0 +1,87 @@
|
|||
---
|
||||
title: Announcing Docusaurus 2 Beta
|
||||
author: Sébastien Lorber
|
||||
authorTitle: Docusaurus maintainer
|
||||
authorURL: https://sebastienlorber.com
|
||||
authorImageURL: https://github.com/slorber.png
|
||||
authorTwitter: sebastienlorber
|
||||
tags: [release, beta]
|
||||
image: /img/blog/2021-05-12-announcing-docusaurus-two-beta/social-card.png
|
||||
---
|
||||
|
||||
After a lengthy alpha stage in order to ensure feature parity and quality, we are excited to officially release the first **Docusaurus 2 beta**.
|
||||
|
||||
With the announcement of this beta, the team is even more confident that Docusaurus 2 is **ready for mainstream adoption**!
|
||||
|
||||

|
||||
|
||||
<!--truncate-->
|
||||
|
||||
## Docusaurus adoption
|
||||
|
||||
**Don't fear the beta tag!**
|
||||
|
||||
Docusaurus 2 is widely adopted and growing fast:
|
||||
|
||||
[](https://www.npmtrends.com/docusaurus-vs-@docusaurus/core)
|
||||
|
||||
To get a fuller understanding of the quality of current Docusaurus 2 sites, our new [showcase](https://docusaurus.io/showcase) page allows you to filter Docusaurus sites by features, so you may get inspired by real-world production sites with a similar use-case as yours!
|
||||
|
||||
Don't miss our [favorite](https://docusaurus.io/showcase?tags=favorite) sites; they all stand out with something unique:
|
||||
|
||||
[](https://docusaurus.io/showcase?tags=favorite)
|
||||
|
||||
## Why was Docusaurus v2 in alpha for so long?
|
||||
|
||||
It's hard to believe that the first alpha release [v2.0.0-alpha.0](https://github.com/facebook/docusaurus/releases/tag/v2.0.0-alpha.0) was 2 years ago 😳 , unusually long for a software alpha.
|
||||
|
||||
As this was a substantial re-architecture of the code base, we wanted to ensure that we had confidence in the stability and features of Docusaurus 2 before moving on to a beta stage, since beta suggests a high level of quality. We are happy to say that Docusaurus 2 has reached **feature parity** with Docusaurus 1 with **[i18n](https://docusaurus.io/blog/2021/03/09/releasing-docusaurus-i18n)**, and it has been **successfully adopted** by many Docusaurus sites (see [i18n showcase](https://docusaurus.io/showcase?tags=i18n)).
|
||||
|
||||
We're now quite confident that the core features of Docusaurus 2 are stable enough to be in beta.
|
||||
|
||||
## What are the goals of the beta?
|
||||
|
||||
Now that Docusaurus 2 is stable and major feature complete, the goal of the beta is to inspire confidence in new users on the production-readiness of Docusaurus 2, migrate more remaining Docusaurus 1 users to version 2, and officially deprecate Docusaurus 1. We will, of course, continue to resolve any issues and bugs that may be discovered.
|
||||
|
||||
In addition, we will use the beta phase to **improve our theming system**.
|
||||
|
||||
We want to make it:
|
||||
|
||||
- **easier to implement a custom theme**, including for ourselves. We want to provide [multiple official themes](https://github.com/facebook/docusaurus/issues/3522) (including [Tailwind CSS](https://github.com/facebook/docusaurus/issues/2961)) for a long time.
|
||||
|
||||
- **safer to extend an existing theme**: it can be painful to upgrade a highly customized Docusaurus site, as customizations can conflict with internal changes. We need to make the theme public API surface more explicit, and make it clear what is safe to customize.
|
||||
|
||||
We will build a better **theming infrastructure** and refactor the classic theme to use it.
|
||||
|
||||
If you customize your site, you may find these planned improvements quite valuable.
|
||||
|
||||
## What's new?
|
||||
|
||||
In case you missed it, we recently shipped two major improvements:
|
||||
|
||||
- [Auto-generated sidebars](https://docusaurus.io/docs/sidebar#sidebar-item-autogenerated): no need to maintain a `sidebars.js` file anymore!
|
||||
- [Webpack 5 / PostCSS 8](https://github.com/facebook/docusaurus/issues/4027): persistent caching significantly speeds up **rebuild time**!
|
||||
|
||||
## What's next?
|
||||
|
||||
Shipping the official 2.0 release!
|
||||
|
||||
To get there, we will continue to **fix bugs** and implement the **most wanted features**, including:
|
||||
|
||||
- [Sidebar category index pages](https://github.com/facebook/docusaurus/issues/2643)
|
||||
- [Proper CSS-in-JS support](https://github.com/facebook/docusaurus/issues/3236)
|
||||
- [Improve build time performance](https://github.com/facebook/docusaurus/issues/4765)
|
||||
- [Extend Docusaurus plugins, CMS integration](https://github.com/facebook/docusaurus/issues/4138)
|
||||
- [Fix trailing slashes and relative link issues](https://github.com/facebook/docusaurus/issues/3372)
|
||||
- [Better compatibility with CommonMark](https://github.com/facebook/docusaurus/issues/3018)
|
||||
- [Upgrade to MDX 2.0](https://github.com/facebook/docusaurus/issues/4029)
|
||||
|
||||
## Conclusion
|
||||
|
||||
This is an exciting time for Docusaurus.
|
||||
|
||||
We are inspired by the [positive feedback](https://twitter.com/sebastienlorber/timelines/1392048416872706049) about Docusaurus, and discover new sites online every single day.
|
||||
|
||||
We are so excited for this release, and hope, by moving from alpha to beta, the community is assured on quality and stability, which, in turn, continues to increase the adoption of Docusaurus. And, for those that have been on the fence from migrating an existing Docusaurus site to Docusaurus 2, it is a great time to upgrade so that you are running on the latest infrastructure when we deprecate Docusaurus 1 at the end of this beta period.
|
||||
|
||||
Thank you to everyone for reading and to the entire community who supports Docusaurus. 🤗
|
After Width: | Height: | Size: 488 KiB |
After Width: | Height: | Size: 200 KiB |
After Width: | Height: | Size: 188 KiB |
After Width: | Height: | Size: 728 KiB |
After Width: | Height: | Size: 126 KiB |
|
@ -42,7 +42,7 @@ description: This is my first post on Docusaurus 2.
|
|||
image: https://i.imgur.com/mErPwqL.png
|
||||
hide_table_of_contents: false
|
||||
---
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://docusaurus.io/).
|
||||
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
|
|
|
@ -128,8 +128,8 @@ Please update to the latest Docusaurus 2 version shown at the top of the page, n
|
|||
|
||||
```json title="package.json"
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "^2.0.0-alpha.49",
|
||||
"@docusaurus/preset-classic": "^2.0.0-alpha.49",
|
||||
"@docusaurus/core": "^2.0.0-beta.0",
|
||||
"@docusaurus/preset-classic": "^2.0.0-beta.0",
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
@ -151,7 +151,7 @@ You should see the correct version as output.
|
|||
Alternatively, if you are using Yarn, you can do:
|
||||
|
||||
```bash
|
||||
yarn upgrade @docusaurus/core@2.0.0-alpha.49 @docusaurus/preset-classic@2.0.0-alpha.49
|
||||
yarn upgrade @docusaurus/core@2.0.0-beta.0 @docusaurus/preset-classic@2.0.0-beta.0
|
||||
```
|
||||
|
||||
## Problems? {#problems}
|
||||
|
|
|
@ -24,15 +24,15 @@ Meanwhile, the default doc site functionalities provided by Docusaurus 1 are now
|
|||
{
|
||||
dependencies: {
|
||||
- "docusaurus": "^1.x.x",
|
||||
+ "@docusaurus/core": "^2.0.0-alpha.48",
|
||||
+ "@docusaurus/preset-classic": "^2.0.0-alpha.48",
|
||||
+ "@docusaurus/core": "^2.0.0-beta.0",
|
||||
+ "@docusaurus/preset-classic": "^2.0.0-beta.0",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
:::tip
|
||||
|
||||
Please use the most recent Docusaurus 2 alpha version, which you can check out [here](https://www.npmjs.com/package/@docusaurus/core) (it's tagged `next`).
|
||||
Please use the most recent Docusaurus 2 version, which you can check out [here](https://www.npmjs.com/package/@docusaurus/core) (using the `latest` tag).
|
||||
|
||||
:::
|
||||
|
||||
|
@ -68,8 +68,8 @@ A typical Docusaurus 2 `package.json` may look like this:
|
|||
"clear": "docusaurus clear"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "^2.0.0-alpha.66",
|
||||
"@docusaurus/preset-classic": "^2.0.0-alpha.66",
|
||||
"@docusaurus/core": "^2.0.0-beta.0",
|
||||
"@docusaurus/preset-classic": "^2.0.0-beta.0",
|
||||
"clsx": "^1.1.1",
|
||||
"react": "^16.8.4",
|
||||
"react-dom": "^16.8.4"
|
||||
|
|
After Width: | Height: | Size: 488 KiB |
After Width: | Height: | Size: 200 KiB |
After Width: | Height: | Size: 188 KiB |
After Width: | Height: | Size: 728 KiB |
After Width: | Height: | Size: 126 KiB |