Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docusaurus v3 #1432

Merged
merged 6 commits into from Dec 21, 2023
Merged

Docusaurus v3 #1432

merged 6 commits into from Dec 21, 2023

Conversation

pd93
Copy link
Member

@pd93 pd93 commented Dec 19, 2023

Docusaurus v3 was recently released. This PR updates Task to use the latest version using their migration guide.

  • Config is now ESM and Typescript
  • Markdown files are now .mdx instead of .md

Another major benefit of this update is that it means that we can more easily use some of the remark plugins that only support ESM. In particular, remark-gfm and remark-github. These allow us to create documentation that will work consistently across our website and GitHub and stops us from having to do weird things in our release script to convert @ and # strings into links.


Edit: Small thing I've noticed. *.mdx files are not yet supported by Prettier, so they no longer autoformat. We could theoretically change the files back to *.md and they would still work with MDX 3, but this support is not permanent.

@pd93 pd93 force-pushed the docusaurus-v3 branch 3 times, most recently from 5a181fa to 715bb00 Compare December 19, 2023 02:18
@pd93 pd93 merged commit 7c93741 into main Dec 21, 2023
11 checks passed
@pd93 pd93 deleted the docusaurus-v3 branch December 21, 2023 01:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant