Build optimized websites quickly, focus on your content. Part of @MetaOpenSource.
Menlo Park, CA
- Tweets 487
- Following 32
- Followers 7,146
- Likes 253
This was just a quick preview of Docusaurus v3
More details in the blog post:
docusaurus.io/blog/releases/…
v3.0 does not come with a huge list of features, but is an important infrastructure upgrade.
This sets the ground for a new wave of Docusaurus features we plan to implement!
2
10
3,393
Inject HTML data attributes with query-string / search params
This can be useful for various reasons
For example, you can customize CSS based on query-string params
Tip: use this to embed Docusaurus as an iframe in another website, and customize the layout
No FOUC expected!
1
2
11
7,016
Docusaurus v3 greatly improves TypeScript support
- Config files support TS
- New official base config
- Normalized TS exports
- Require TS 5.0+
1
4
476
React 18!
This comes up with all React 18 improvements
We'll soon explore how to properly support Suspense/React.lazy in Docusaurus
We also use the automatic JSX runtime, and you don't need to import React anymore
1
6
504
Unlisted content!
We had "draft: true" front matter
Now we have "unlisted: true" 🆕
This will publish your pages in production builds, but make them "secret"
Impossible to discover: noindex, search, sitemap, RSS, sidebars...
Ideal for getting final review before publication!
1
7
574
Now let's focus on a few features we particularly like.
ESM and TypeScript configs!
This new support should greatly improve the Docusaurus DX!
And it's not only for your site config, but also docs sidebars, plugins, and preset modules!
1
6
607
Seb ⚛️ ThisWeekInReact.com @sebastienlorber
MDX v1 ➡️ MDX v3 is the main challenge to adopt Docusaurus v3
Docs that compiled successfully under Docusaurus v2 might now fail to compile under Docusaurus v3
But we went the extra mile to make it less difficult for you!
1
5
696
Non-complex Docusaurus sites should be able to adopt v3 very easily
All you have to do is update a few dependencies and you're ready to go!
1
7
984
This is a new major version of Docusaurus, coming with new exciting features.
We respect Semantic Versioning principles: this release also includes breaking changes.
They are exhaustively documented in the v3 upgrade guide.
Release blog post: docusaurus.io/blog/releases/…
1
1
10
1,471
💥 Docusaurus v3.0 stable is available! 💥
➡️ MDX 3
➡️ React 18 / Automatic JSX runtime
➡️ ESM + TS Config
➡️ Unlisted content
➡️ TypeScript 5
➡️ Mermaid 10
➡️ Node 18
➡️ CommonMark (experimental)
🧵 Details below 👇
5
58
270
75,675
Many other changes too!
Check the full changelog here:
docusaurus.io/changelog/2.4.…
This is likely the last 2.x minor release.
The next one should be v3.0, including MDX 2 and React 18 🤞 🙌
👋
1
4
1,845
🧵 Many translation improvements
New translations:
🇭🇺 Hungarian
🇳🇴 Norwegian (Bokmål)
New DOCUSAURUS_CURRENT_LOCALE
➡️ experimental workaround to translate your site config: title, tagline, announcement bar...
1
1
1,681
🧵 Developer Experience improvements
Better error screens
Better navbar error messages, explain how to fix the problem
Display error cause messages (from ES2021 Error Cause)
1
502
🧵 gtag support for multiple tracking IDs
Makes it possible to report analytics to 2 Google properties
Useful for seamless migration from Universal Analytics to Google Analytics 4
1
386
🧵 Remark plugin npm2yarn upgrade
Our little util to convert npm code blocks to tabs 💡
Many conversion bugs fixed
First-class support to convert commands from npm to pnpm
Ability to register extra tabs/converters
Example: add Turborepo tab?
1
379
🧵 Theme Query String
Add the possibility to force Docusaurus to initialize itself in light or dark mode through
New ?docusaurus-theme query-string param
This is useful to ensure a consistent theme when embedding an existing Docusaurus page into an iframe or WebView.
1
1
325
🧵 Sidebar item description
We made it possible to provide a new description attribute for docs sidebar items of type link and category.
These descriptions will be used in category generated index pages.
1
366
💥 Docusaurus v2.3.1 is available! 💥
Little release fixing some 2.3.0 bugs, notably:
🐛 Tabs scroll position restoration, single tab items
🐛 Fix preset rejecting Google Tag Manager config
🐛 Fix infinite loop console error when switching theme
🔗 github.com/facebook/docusaur…
8
23
6,281
🧵 Many little improvements to UX, DX, a11y, translations...
Check the changelog for a more exhaustive list!
docusaurus.io/changelog/2.3.…
The Docusaurus team is working on the v3 release, which should include MDX 2 + React 18
👋
6
1,009
🧵 Blog createFeedItems
Callback to transform/filter/limit feed items.
Gives you flexibility to achieve fancy use-cases:
- limit blog feed size for very large blogs
- add a title prefix or emojis to feed item titles
- add blog content footer
...whatever you have in mind
1
1
4
1,169
🧵 Admonitions can now be nested 👌
Make sure to use more colons for enclosing admonitions (:::: or more)
1
1
5
359
🧵 Tabs Query String Support
The selected tab can now be persisted in the browser URL
Permits deep linking ➡️ share direct link to specific tab
1
6
352
🧵 Google Tag Manager plugin
Because giving flexibility to analytics/marketing teams is important.
Note: Google is sunsetting Universal Analytics, and we deprecate our google-analytics plugin.
Upgrade to our Gtag or GTM plugin asap
1
2
374
🏆 Vote for Docusaurus for the @ProductHunt Golden Kitty Awards 2022
🦖 😘 🐱
producthunt.com/golden-kitty…
2
2
8
3,567
🎉 Docusaurus reached 40000 GitHub stars 🎊
Thanks for your support everyone 😍
🦖 🦖 🦖 🦖 🦖
5
11
181
28,141
New great community resource 🙌
Useful if you want to discover some new Docusaurus plugins
docusaurus.community/
Thanks @homotechsual
1
20
😍 Use Docusaurus for your wedding site 💖 💒
andrewandrosie.com/
x.lingyaoai.com/kilroysayswhat/status/…
1
12
We also completed the translations of 4 new languages.
Your help is appreciated to keep Docusaurus translated as we add new features 🙏
Many other improvements!
1
2
We did several accessibility and DX improvements
Improves keyboard navigation, progressive enhancement, and screen-reader support...
Stricter validation, better error messages!
1
Support for siteConfig.headTags API
Gives good flexibility to add a tag in HTML <head> of all your pages
You can add meta, link, or anything else
github.com/facebook/docusaur…
1
1
Support for Mermaid diagrams!
Like the new GitHub Flavored Markdown feature, we support it by using a ```mermaid code block inside a Markdown file
Doc: docusaurus.io/docs/markdown-…
Examples: docusaurus.io/tests/pages/di…
PR: github.com/facebook/docusaur…
1
10
💥 Docusaurus v2.2.0 is available! 💥
Minor version with some new features 🙌
No breaking change, upgrade should be easy! 👌
⚡️ Mermaid diagrams!
🆕 config.headTags API
💅 Accessibility & DX
🇹🇷 🇷🇺 🇫🇷 🇯🇵 Completed theme translations
Post: docusaurus.io/blog/releases/…
🧵👇
4
16
135
There are various other useful bug fixes and improvements.
Make sure to check our full release changelog:
docusaurus.io/changelog/2.1.…
We also added the ability to override some default hardcoded HTML <meta> tags that you couldn't previously
And the classic theme ships with Ukrainian translations by default
1
1
2
We had a great launch on @ProductHunt last week 👌
Thanks for all the upvotes and comments everyone! ❤️️
producthunt.com/newsletter/1…
1
16
@OuterboundsHQ docs is a great example to show how flexible Docusaurus is 👌
We are really excited to share how we built our technical documentation stack with #nbdev, @juptyer, and @docusaurus 🎉
outerbounds.com/blog/technic…
3
3
💝 We made it! ️🦖
🥇 Product of the day 👌
Thanks a lot to everyone who supported me!
producthunt.com/posts/docusa…
1
1
37
⏱ 4 hours left on Product Hunt
💝 I really wish you'll make me the product of the day 🥇
🔗 producthunt.com/posts/docusa…
1
7
⏱ 8 hours left
🥇 Soon, I could become the product of the day on Product Hunt!
💝 Please share your experience using Docusaurus with the community!
🔗 producthunt.com/posts/docusa…
5
Docusaurus is one of @MetaOpenSource most successful projects
We can't wait to see all the outstanding documentation websites that you will create!
🙏 Don't forget to submit them to our site showcase
Now, let your imagination run wild 🤪
— Slash
🔗 docusaurus.io/blog/2022/08/0…
2
2
9
🎢 It's been a long ride
We'd like to thank all our past and current contributors 🥂
But in particular all of our early adopters! 🧪
️
You provided a ton of invaluable feedback and positive testimonials 💝
We sincerely hope you had a great experience using it 😃
1
1
11
⏭ Now, what's next?
🏎 Frequent major version releases, like other projects do!
Today, we start the work on Docusaurus 3.0, expected to ship in 3 months
We'll backport v3 retro-compatible changes to v2
Many highly anticipated improvements are already on our roadmap
1
10
🐢 Why did it take so long to release 2.0 ⁉️
It's already been stable for a while and widely used in production
➡️ We want to respect Semantic Versioning
🚧 Important theme refactors were needed
We want to make it easier to upgrade customized sites!
docusaurus.io/community/rele…
1
7
A lot of companies are now using Docusaurus v2!
Our showcase references almost 300 sites 🤯
docusaurus.io/showcase
This is only the tip of the iceberg:
- many sites have not been submitted: Figma, Snapchat, Solana...
- strong internal usage at Microsoft, LinkedIn, Shopify...
1
12
📈 Some stats:
Despite being in pre-release, v2 has been growing fast!
NPM downloads: it didn't take long for Docusaurus v2 to outgrow Docusaurus v1 in terms of NPM downloads
GitHub stars: our trend is very positive, competing with major frameworks
1
8
💪 Apart from big architectural changes, Docusaurus v2 also comes full-featured!
We kept everything good in v1 and added many new useful features
The community also built many great plugins
- local search
- OpenAPI
- Mermaid diagrams
- image zoom
- TypeScript tooling
...
1
11
🆕 v2 work started in 2018
100% rebuilt from scratch:
- plugin system
- modular architecture
- filesystem conventions
- use React/MDX, create interactive docs
- truly customizable
🎨 v2 sites can really look very different and respect your branding 👌
docusaurus.io/showcase
1
1
20
v1 was released in 2017
Adopted by Prettier, Babel, React-Native, Jest, KaTeX...
👏 Great success, but we saw the limits:
- limited theming
- not extensible
- doc is not interactive
- monolithic
v1 site showcase: v1.docusaurus.io/en/users
v1 sites all look quite similar 🤷♂️
1
12
📜 Docusaurus story
At Meta (Facebook) we have a lot of internal/external projects
It's complicated enough to write good documentation
Let alone create a custom doc site for every project
We wanted to focus on what really matters: Markdown content
💡 Docusaurus was born
1
14
🎥 Docusaurus 2.0 is now ready for prime time️
🤯 4 years of work, 75 alphas, 22 betas
We now plan to respect Semantic Versioning
New major versions (ie v3.0) are expected every 3 months
We are on @ProductHunt today! 😉
Please leave us a comment!
🔗 producthunt.com/posts/docusa…
2
1
33
🎉 Announcing Docusaurus 2.0 - by @MetaOpenSource 🥳
Build a top-notch documentation site in no time!
✒️ Focus on your content: just write Markdown files
💪 Full-featured, extensible
🎨 Truly customizable
⚛️ Interactive doc, React/MDX
🧵 👇
docusaurus.io/blog/2022/08/0…
17
222
919
Guess who is using Docusaurus ❔
@stackblitz 🙌
Another great-looking developer portal 👌
Respects nicely the branding of the company 🎨
🔗 developer.stackblitz.com/
3
10
💡 Get your site featured in the Docusaurus showcase
👌 Just submit your site url, we will handle the rest
⏱️ It only takes a few seconds!
🙏 Submit it here ➡️ github.com/facebook/docusaur…
1
3
16
Guess who is using Docusaurus ⁉️
➡️ @Snapchat 🙌
A great looking theme with subtle tweaks 👌
docs.snap.com/
1
5
14
The Crypto & Web3 community love Docusaurus
Just take a look at this beautiful @iota developer portal ❤️️
wiki.iota.org/
3
56
218
Guess who is using Docusaurus?
@figma 🙌
Nice site customizations 👌
figma.com/plugin-docs/
figma.com/plugin-docs/
1
4
28
Guess who's using Docusaurus?
@Ionicframework 🙌
Impressive site customizations 👌
Nice integration with an interactive phone sandbox
ionicframework.com/docs/
3
9
86
This release contains a few breaking changes, as we refactor the theme to make it easier to swizzle
If case of problem, try to re-swizzle and apply again your customizations
1
2
The labels of the Algolia search modal are now translatable
We'll provide good default translations for you, some languages already include those
1
3
Markdown admonitions are now mapped to theme JSX components instead of static html markup
This means you can now customize admonitions with swizzle 👍
+ the admonition type/title is now translatable
github.com/facebook/docusaur…
1
1
DocItem + BlogPostItem are split into much smaller components.
This gives much more opportunities to customize with swizzle while not duplicating too much code
=> Easy to intersperse your own components into the existing design/layout
1
Docusaurus is a React framework too 😏
Here are 7 ways to create a React app in 2022. This feature matrix shows some key differences at a glance.
List includes:
@vite_js
@nextjs
@remix_run
@GatsbyJS
@RedwoodJS
@ShopifyDevs Hydrogen
#react
2
4
28
Docusaurus + MDX Pro Tip:
You don't necessarily need to import React components in MDX files
Just "register" them globally, and they'll be available by default everywhere
deploy-preview-7503--docusau…
2
3
17
Navbar has a new "html" item type
It can also be nested in a dropdown too, like we did on our own site!
Note: we also suggest a workaround for "custom navbar item types": github.com/facebook/docusaur…
1
1
Doc sidebar layout shifts
Very annoying UX when you uncollapse the sidebar categories
Now fixed 💪
1
2
Doc draft front matter!
Add it and the blog post will disappear from production builds
Also removed from the doc sidebar
It will only be visible in dev locally
1
2
