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

chore: upgrade to docusaurus 3 #5838

Merged
merged 1 commit into from
Apr 8, 2024
Merged

Conversation

etrepum
Copy link
Collaborator

@etrepum etrepum commented Apr 5, 2024

In #5809 I added some gfm table syntax which docusaurus 2 doesn't render by default. I tried including the remark-gfm plugin with docusaurus 2 but it didn't work for esm reasons (my villain arc) so here is an upgrade to docusaurus 3 where it does work (and remark-gfm is enabled by default).

I did have to change broken links from throw to warn mostly because there are broken links and it just wasn't catching them before. I've noticed at least one misspelling and otherwise a systemic problem is that typedoc labels must be [a-z_][0-9a-z_]* but JavaScript and TypeScript names can have other characters, like our beloved $. typedoc seems perfectly happy to strip these from the labels it generates, but it doesn't do the same kind of normalization for something like {@link lexical!$getRoot} so it will generate an anchor #$getroot but it should be #getroot. I'm looking into a workaround for this but that will likely take a little longer.

Copy link

vercel bot commented Apr 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 7, 2024 3:50pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 7, 2024 3:50pm

Copy link
Member

@zurfyx zurfyx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@zurfyx zurfyx merged commit 05ecba3 into facebook:main Apr 8, 2024
45 checks passed
@acywatson acywatson mentioned this pull request Apr 16, 2024
@etrepum etrepum deleted the docusaurus-3 branch May 11, 2024 06:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants