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

build: docusaurus 3.5 upgrade #622

Merged
merged 4 commits into from
Aug 12, 2024
Merged

build: docusaurus 3.5 upgrade #622

merged 4 commits into from
Aug 12, 2024

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Aug 12, 2024

Updates to Docusaurus 3.5.

  • Reverts 1f8a694 since the feature was upstreamed. Removed patch-package since we don't need patches anymore.
  • Added mdast-util-mdx to the dependency tree so that we can pass it in as an extension to toMarkdown(). We do some hacky Markdown -> MDAST -> Markdown conversion in the API structure preview transformer that now has an MDX node by default as of feat(mdx-loader): wrap mdx content title (# Title) in <header> for concistency facebook/docusaurus#10335 so this is needed to render those previews now.
  • Changed an internal import that was updated in the latest version.

@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-622 August 12, 2024 20:26 Inactive
@erickzhao erickzhao changed the title wip wip: docusaurus 3.5 upgrade Aug 12, 2024
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-622 August 12, 2024 20:42 Inactive
@erickzhao erickzhao changed the title wip: docusaurus 3.5 upgrade build: docusaurus 3.5 upgrade Aug 12, 2024
@MarshallOfSound MarshallOfSound temporarily deployed to electronjsorg-new-pr-622 August 12, 2024 22:10 Inactive
@erickzhao erickzhao marked this pull request as ready for review August 12, 2024 22:17
@erickzhao erickzhao requested a review from a team as a code owner August 12, 2024 22:17
Copy link
Member

@alicelovescake alicelovescake left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning up my patches!

@erickzhao erickzhao merged commit d681f45 into main Aug 12, 2024
4 checks passed
@erickzhao erickzhao deleted the docusaurus-3.5 branch August 12, 2024 22:52
@dsanders11
Copy link
Member

This got merged as I was writing this up. 😅

Looks like there's a few visual changes to the blog as a result of this PR. Not to bikeshed too much, but I kind prefer some parts of the blog sidebar as they currently are, like the border below the title. I wonder if we can retain any of those styles without needing to swizzle the whole component?

The blog author name not being centered vertically looks to be intentional but IMO is awkward looking. Looks like if we used the new authors pages features and put author's GitHub as a social it might render better.

Before:

Before

After:

After

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.

4 participants