+[RFC] Docusaurus v2 · Issue #789 · facebook/docusaurus
These are some of the problems I'm seeing in Docusaurus now and also how we can address them in v2. A number of the ideas here were inspired by VuePress and other static site generators. In the current static site generators ecosystem, t...
+Most of the suggested improvements are mentioned in the issue; I will provide details on some of issues in Docusaurus 1 and how we are going to address them in Docusaurus 2. diff --git a/website/blog/2018-12-14-Happy-First-Birthday-Slash.md b/website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx similarity index 100% rename from website/blog/2018-12-14-Happy-First-Birthday-Slash.md rename to website/blog/2018-12-14-Happy-First-Birthday-Slash.mdx diff --git a/website/blog/2019-12-30-docusaurus-2019-recap.md b/website/blog/2019-12-30-docusaurus-2019-recap.mdx similarity index 100% rename from website/blog/2019-12-30-docusaurus-2019-recap.md rename to website/blog/2019-12-30-docusaurus-2019-recap.mdx diff --git a/website/blog/2020-01-07-tribute-to-endi.md b/website/blog/2020-01-07-tribute-to-endi.mdx similarity index 100% rename from website/blog/2020-01-07-tribute-to-endi.md rename to website/blog/2020-01-07-tribute-to-endi.mdx diff --git a/website/blog/2021-01-19-docusaurus-2020-recap.md b/website/blog/2021-01-19-docusaurus-2020-recap.mdx similarity index 100% rename from website/blog/2021-01-19-docusaurus-2020-recap.md rename to website/blog/2021-01-19-docusaurus-2020-recap.mdx diff --git a/website/blog/2021-03-09-releasing-docusaurus-i18n.md b/website/blog/2021-03-09-releasing-docusaurus-i18n.mdx similarity index 100% rename from website/blog/2021-03-09-releasing-docusaurus-i18n.md rename to website/blog/2021-03-09-releasing-docusaurus-i18n.mdx diff --git a/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.md b/website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx similarity index 100% rename from website/blog/2021-05-12-announcing-docusaurus-two-beta/index.md rename to website/blog/2021-05-12-announcing-docusaurus-two-beta/index.mdx diff --git a/website/blog/2021-11-21-algolia-docsearch-migration/index.md b/website/blog/2021-11-21-algolia-docsearch-migration/index.mdx similarity index 100% rename from website/blog/2021-11-21-algolia-docsearch-migration/index.md rename to website/blog/2021-11-21-algolia-docsearch-migration/index.mdx diff --git a/website/blog/2022-01-24-docusaurus-2021-recap/index.md b/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx similarity index 96% rename from website/blog/2022-01-24-docusaurus-2021-recap/index.md rename to website/blog/2022-01-24-docusaurus-2021-recap/index.mdx index a577b54361..7a7863c63d 100644 --- a/website/blog/2022-01-24-docusaurus-2021-recap/index.md +++ b/website/blog/2022-01-24-docusaurus-2021-recap/index.mdx @@ -7,7 +7,7 @@ image: ./img/thumbnail.png Docusaurus has made great progress in 2021! We've seen a lot of traction and just crossed **30k stars on GitHub**! -We've **reached full feature parity** with v1 after [the release of internationalization](../2021-03-09-releasing-docusaurus-i18n.md), [announced our **first beta**](../2021-05-12-announcing-docusaurus-two-beta/index.md), and welcomed **significantly more users** this year. +We've **reached full feature parity** with v1 after [the release of internationalization](../2021-03-09-releasing-docusaurus-i18n.mdx), [announced our **first beta**](../2021-05-12-announcing-docusaurus-two-beta/index.mdx), and welcomed **significantly more users** this year. The **official v2 release** is just around the corner! Follow the [roadmap issue](https://github.com/facebook/docusaurus/issues/6113) for any latest news. @@ -17,7 +17,7 @@ The **official v2 release** is just around the corner! Follow the [roadmap issue ## Highlights -Let's begin by going over a few highlights this year. Remember the [todo-list](../2021-05-12-announcing-docusaurus-two-beta/index.md#whats-next) from half a year ago? Time to take it out again and see how far we've come! +Let's begin by going over a few highlights this year. Remember the [todo-list](../2021-05-12-announcing-docusaurus-two-beta/index.mdx#whats-next) from half a year ago? Time to take it out again and see how far we've come! - **Internationalization**: officially released four months after its initial landing in late 2020. Seen great success in [many projects](/showcase?tags=i18n) - **Autogenerated sidebars**: no need to maintain a big `sidebars.js` anymore @@ -118,7 +118,7 @@ We'd like to express our gratitude to [all the contributors in 2021](https://git - The core team: [Alexey Pyltsyn](https://github.com/lex111), [Sébastien Lorber](https://github.com/slorber), [Joshua Chen](https://github.com/Josh-Cena), and [Yangshun Tay](https://github.com/yangshun) for moderating the community, publicizing Docusaurus, triaging issues, and implementing new features - [Joel Marcey](https://github.com/JoelMarcey) for creating Docusaurus and supporting its development all along -- The Algolia team for helping Docusaurus users [migrate to the new DocSearch](../2021-11-21-algolia-docsearch-migration/index.md) and answering search-related questions +- The Algolia team for helping Docusaurus users [migrate to the new DocSearch](../2021-11-21-algolia-docsearch-migration/index.mdx) and answering search-related questions - All the active community members for making valuable code contributions, improving our documentation, and answering questions on Discord So long, 2021, and let's greet a great 2022! diff --git a/website/blog/2022-08-01-announcing-docusaurus-2.0/index.mdx b/website/blog/2022-08-01-announcing-docusaurus-2.0/index.mdx index ff246238fa..6d97a024fb 100644 --- a/website/blog/2022-08-01-announcing-docusaurus-2.0/index.mdx +++ b/website/blog/2022-08-01-announcing-docusaurus-2.0/index.mdx @@ -95,7 +95,7 @@ Docusaurus was created at **Facebook Open Source** in **2017** (now [Meta Open S At that time, our solution was to **copy/paste a Jekyll template** over and over again. This naturally became **hard to maintain**, so we created a tool to **solve our own pain** once for all. -**[Docusaurus v1 was born](../2017-12-14-introducing-docusaurus.md)!** +**[Docusaurus v1 was born](../2017-12-14-introducing-docusaurus.mdx)!**  @@ -129,7 +129,7 @@ Notice that the sample sites above use different colors, but still look quite th - We kept **everything good from v1**: docs, blog, pages, versioning, i18n... - We implemented **several new features** -More details in the [Docusaurus 2 project announcement](../2018-09-11-Towards-Docusaurus-2.md) and [v1 to v2 migration guide](https://docusaurus.io/docs/migration) +More details in the [Docusaurus 2 project announcement](../2018-09-11-Towards-Docusaurus-2.mdx) and [v1 to v2 migration guide](https://docusaurus.io/docs/migration) ## Who uses Docusaurus 2.0? @@ -420,7 +420,7 @@ We'd like to express our gratitude to [all our contributors](https://github.com/ - [Joel Marcey](https://github.com/JoelMarcey) for creating Docusaurus 1.0 and supporting the Docusaurus 2.0 project at Meta Open Source - [Paul O’Shannessy](https://github.com/zpao) for supporting the development of all the next versions of Docusaurus at Meta Open Source - [Eric Nakagawa](https://github.com/ericnakagawa) for creating our cutest mascot Slash -- [Endilie Yacop Sucipto](https://github.com/endiliey) for his significant [initial work on Docusaurus v2](../2020-01-07-tribute-to-endi.md) +- [Endilie Yacop Sucipto](https://github.com/endiliey) for his significant [initial work on Docusaurus v2](../2020-01-07-tribute-to-endi.mdx) - [Clément Vannicatte](https://github.com/shortcuts), [Kevin Granger](https://github.com/Shipow) and the whole Algolia team for their support - All the community members for making valuable code contributions, improving our documentation, and answering questions on [Discord](https://discordapp.com/invite/docusaurus) diff --git a/website/community/0-support.md b/website/community/0-support.mdx similarity index 100% rename from website/community/0-support.md rename to website/community/0-support.mdx diff --git a/website/community/2-resources.md b/website/community/2-resources.mdx similarity index 100% rename from website/community/2-resources.md rename to website/community/2-resources.mdx diff --git a/website/community/3-contributing.md b/website/community/3-contributing.mdx similarity index 100% rename from website/community/3-contributing.md rename to website/community/3-contributing.mdx diff --git a/website/community/4-canary.md b/website/community/4-canary.mdx similarity index 98% rename from website/community/4-canary.md rename to website/community/4-canary.mdx index ae866c4d33..a6f278899f 100644 --- a/website/community/4-canary.md +++ b/website/community/4-canary.mdx @@ -16,7 +16,7 @@ import { Docusaurus has a canary releases system. -It permits you to **test new unreleased features** as soon as the pull requests are merged on the [next version](./5-release-process.md#next-version) of Docusaurus. +It permits you to **test new unreleased features** as soon as the pull requests are merged on the [next version](./5-release-process.mdx#next-version) of Docusaurus. It is a good way to **give feedback to maintainers**, ensuring the newly implemented feature works as intended. diff --git a/website/community/5-release-process.md b/website/community/5-release-process.mdx similarity index 99% rename from website/community/5-release-process.md rename to website/community/5-release-process.mdx index 4c76f0e563..a7d9d8c68b 100644 --- a/website/community/5-release-process.md +++ b/website/community/5-release-process.mdx @@ -113,7 +113,7 @@ There are 3 ways to use the next version: - with an `alpha`, `beta` or `rc` pre-release - with the `@next` npm dist tag for the latest pre-release -- with a [canary release](./4-canary.md) for the very latest features +- with a [canary release](./4-canary.mdx) for the very latest features :::tip diff --git a/website/src/pages/examples/markdownPageExample.md b/website/src/pages/examples/markdownPageExample.mdx similarity index 100% rename from website/src/pages/examples/markdownPageExample.md rename to website/src/pages/examples/markdownPageExample.mdx diff --git a/website/src/pages/examples/noIndex.md b/website/src/pages/examples/noIndex.mdx similarity index 100% rename from website/src/pages/examples/noIndex.md rename to website/src/pages/examples/noIndex.mdx diff --git a/website/src/pages/tests.md b/website/src/pages/tests.mdx similarity index 100% rename from website/src/pages/tests.md rename to website/src/pages/tests.mdx+ + [RFC] Docusaurus v2 · Issue #789 · facebook/docusaurus + +
++ These are some of the problems I'm seeing in Docusaurus now and also how we + can address them in v2. A number of the ideas here were inspired by VuePress + and other static site generators. In the current static site generators + ecosystem, t... +
+