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

Astro 5 + collection loaders + legacy collections support #2612

Merged
merged 91 commits into from
Dec 13, 2024

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Nov 18, 2024

Description

This PR is a draft adding Astro 5 support to Starlight, adding collection loaders for our content collections and support for legacy collections.

The first goal was to get everything working with Astro 5. There is room for improvements and potential refactoring, but the goal was to get everything in place first to get a better overview of what needs to be done and later iterate on it.

The MDX dependency case is temporarily workaround by making it a peer dependency of Starlight and installing it manually everywhere it's needed until we have a better solution (in discussion).

Note that the collection locations are not yet user-configurable.

Remaining tasks

  • Ensure all // TODO(HiDeoo) comments are addressed and removed
  • Figure out if legacy collections support should be documented more (it's only a sentence + link in the manual setup page now)
  • Peer dependency bump for @astrojs/starlight in some packages (see changesets for the one that needs an update)
  • Add changesets
  • Merge with Lunaria directives to ignore the changes to all code.mdx files
    • @lunaria-ignore:src/content/docs/**/code.mdx;src/content/docs/code.mdx;

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

It's happening! Some thoughts for your consideration

.changeset/green-suns-drive.md Show resolved Hide resolved
.changeset/green-suns-drive.md Outdated Show resolved Hide resolved
.changeset/green-suns-drive.md Outdated Show resolved Hide resolved
.changeset/green-suns-drive.md Outdated Show resolved Hide resolved
delucis and others added 3 commits December 13, 2024 22:00
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

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

Here goes nothing!

5k GitHub Stars, 5k “used-by” projects on GitHub, we must be ready for Astro 5k 🚀

Massive thanks to @HiDeoo for guiding this work and starting our new adventures with ✨ Content Layer

@delucis delucis merged commit 8d5a4e8 into withastro:main Dec 13, 2024
16 checks passed
@astrobot-houston astrobot-houston mentioned this pull request Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 action Changes to GitHub Action workflows 🌟 core Changes to Starlight’s main package 📚 docs Documentation website changes 🌟 docsearch Changes to Starlight’s DocSearch plugin i18n Anything to do with internationalization & translation efforts 🌟 markdoc Changes to Starlight’s Markdoc package 🌟 tailwind Changes to Starlight’s Tailwind package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants