feat: upgrade to docusaurus v3

[uncenter]

https://docusaurus.io/blog/releases/3.0

Breaking changes here are Node 16 to Node 18, MDX v1 to v3, and prism-react-renderer@v2. We don't have to but I'm also working on switching to TypeScript where possible.

• Removerequire() usage
• Update to new prism-react-renderer renderer api / make sure themes work (v1 to v2 Migration Guide FormidableLabs/prism-react-renderer#217)
• Update content to MDX3 (check validity withbunx docusaurus-mdx-checker/pnpm dlx docusaurus-mdx-checker, use v2 guide: https://mdxjs.com/migrating/v2/)
• Update other JS config files, TS where possible

[uncenter]

Looks like Prettier is pretty far behind in terms of MDX support (prettier/prettier#12209), let's see if there are any formatting issues but we might have to put this off.

[sxyazi]

Currently only https://github.com/yazi-rs/yazi-rs.github.io/blob/main/usage/configuration/overview.mdx is in MDX format, but in fact it doesn't use any MDX features, I think it can be converted to Markdown.

[uncenter]

There's also https://github.com/yazi-rs/yazi-rs.github.io/blob/main/usage/quick-start.md?plain=1#L134-L182 though.

EDIT: I'll disable MDX and I think the formatting is fine enough for that one section I just linked to.

[sxyazi]

Oh yes. I agree to disable it first.

BTW I found a new markdown formatter https://github.com/remarkjs/remark. I'll add it to my nvim configuration and give it a try later to see if it works normally.

[uncenter]

I don't see any remaining issues visually. Can you take a look through and let me know if there are any other issues?

[sxyazi]

I recreated the site with Docusaurus CLI & --typescript and moved everything back in. I also thought we could switch from "Usage" and /usage/ to "Docs" and /docs/.

Good point! Previously the repo was 'yazi-rs/docs', it corresponded to https://yazi-rs.github.io/docs/. If its name were 'docs', it would have been https://yazi-rs.github.io/docs/docs/.

But now this issue no longer exists, and 'docs' is even shorter than 'usage', I like it! 😍

[uncenter]

I also thought we could rename "Showcase" to "Features" but I'll do that in a separate PR after this merges.

[sxyazi]

I also thought we could rename "Showcase" to "Features" but I'll do that in a separate PR after this merges.

This page will include some user created plugins (once the plugin system is available), seems "features" is not quite accurate - it's generally provided by the official imo

[uncenter]

I also thought we could rename "Showcase" to "Features" but I'll do that in a separate PR after this merges.

This page will include some user created plugins (once the plugin system is available), seems "features" is not quite accurate - it's generally provided by the official imo

That's why I think we should have a separate features and showcase page. For features built in to Yazi, those go on Features. For custom plugins from the community that we want to showcase, we put those in Showcase.

[sxyazi]

That's why I think we should have a separate features and showcase page. For features built in to Yazi, those go on Features. For custom plugins from the community that we want to showcase, we put those in Showcase.

Sounds good, I hadn't thought about separating them ;)

[sxyazi]

Looks great to me!

[uncenter]

Awesome. I'll give you the honor of merging!

[uncenter]

FYI @sxyazi I think Prettier works just fine for the MDX we have so far. I don't think we need to switch to Remark.

[uncenter]

And you've probably already seen this but: davidmh/cspell.nvim#19