Skip to content

Update @astrojs/mdx to v3#1846

Merged
delucis merged 14 commits intomainfrom
dx-1252/mdx-v3
May 17, 2024
Merged

Update @astrojs/mdx to v3#1846
delucis merged 14 commits intomainfrom
dx-1252/mdx-v3

Conversation

@delucis
Copy link
Copy Markdown
Member

@delucis delucis commented May 9, 2024 •
edited
Loading

Description

  • Updates the version of @astrojs/mdx bundled with Starlight to the new v3 release, which comes with several performance improvements
  • Enables the optimize option to MDX for even faster builds.
  • Also updates the peer dependency version of Astro, which is now ^4.8.0 ^4.8.6
  • Taking the Starlight docs as a benchmark, it looks like builds are roughly 40% faster for us. Will be curious to see how things improves for other people!

Some other small changes I needed to make:

@vercel
Copy link
Copy Markdown

vercel bot commented May 9, 2024 •
edited
Loading

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

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview May 17, 2024 2:39pm
1 Ignored Deployment
Name Status Preview Updated (UTC)
starlight-i18n ⬜️ Ignored (Inspect) May 17, 2024 2:39pm

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented May 9, 2024 •
edited
Loading

🦋 Changeset detected

Latest commit: 6fe71de

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@astrojs/starlight Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added 📚 docs Documentation website changes 🌟 core Changes to Starlight’s main package labels May 9, 2024
@delucis delucis added the 🌟 minor Change that triggers a minor release label May 9, 2024
@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented May 9, 2024 •
edited
Loading

size-limit report 📦

Path Size
/index.html 5.26 KB (-13.94% 🔽)
/_astro/*.js 21.81 KB (-0.92% 🔽)
/_astro/*.css 13.46 KB (0%)

@github-actions github-actions bot added the 🌟 tailwind Changes to Starlight’s Tailwind package label May 9, 2024
HiDeoo
HiDeoo approved these changes May 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@HiDeoo HiDeoo left a comment

Choose a reason for hiding this comment

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

Tested a few scenarios locally and could not find any specific issue, this is looking like a pretty amazing update to me 🌟

ematipico
ematipico approved these changes May 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

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

Great! Looking forward to the next release

This was referenced May 14, 2024
Merged
Merged
bluwy
bluwy approved these changes May 15, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@bluwy bluwy left a comment

Choose a reason for hiding this comment

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

Missed this PR. Looking forward to this!

@github-actions github-actions bot removed the 🌟 tailwind Changes to Starlight’s Tailwind package label May 15, 2024
@delucis
Copy link
Copy Markdown
Member Author

delucis commented May 16, 2024

Given Astro 4.8 seems to break script hoisting MDX and this forces an upgrade to 4.8, we might need to hold off merging this until withastro/astro#11063 is fixed?

@bluwy
Copy link
Copy Markdown
Member

bluwy commented May 17, 2024

I've sent withastro/astro#11084 that fixes it.

@delucis
Copy link
Copy Markdown
Member Author

delucis commented May 17, 2024

Thank you for the quick fix @bluwy! 💖

@delucis delucis merged commit 2de6703 into main May 17, 2024
@delucis delucis deleted the dx-1252/mdx-v3 branch May 17, 2024 14:44
@astrobot-houston astrobot-houston mentioned this pull request May 17, 2024
Merged
HiDeoo added a commit to HiDeoo/starlight that referenced this pull request May 20, 2024
@HiDeoo
Merge branch 'main' into hd-refactor-astro-i18n
897f0bf 
* main: (45 commits)
  i18n(tr): add `showcase.mdx` (withastro#1896)
  [ci] format
  i18n(zh-cn): Update `authoring-content.md` (withastro#1901)
  [ci] format
  [ci] release (withastro#1897)
  [ci] format
  i18n(tr): update `authoring-content.md` (withastro#1887)
  Micro-optimization: clean up `<details>` CSS (withastro#1892)
  [ci] format
  i18n(tr): update `components.md` file (withastro#1889)
  [ci] format
  i18n(tr): add css-and-tailwind (withastro#1893)
  [ci] format
  [ci] release (withastro#1890)
  Adds custom styles for `<details>` and `<summary>` elements in Markdown content (withastro#1735)
  Update @astrojs/mdx to v3 (withastro#1846)
  [ci] format
  [ci] release (withastro#1869)
  Add BlueSky social icon (withastro#1871)
  [ci] format
  ...
Yoxnear pushed a commit to Yoxnear/starlight-custom that referenced this pull request Jul 23, 2025
@delucis
Update @astrojs/mdx to v3 (withastro#1846)
74cfd49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@HiDeoo HiDeoo HiDeoo approved these changes

@ematipico ematipico ematipico approved these changes

+1 more reviewer

@bluwy bluwy bluwy approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes 🌟 minor Change that triggers a minor release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@delucis @astrobot-houston @bluwy @HiDeoo @ematipico