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

Upgrade to Gatsby 5 #150

Merged
merged 6 commits into from
May 15, 2023
Merged

Conversation

tekmaven
Copy link
Contributor

@tekmaven tekmaven commented May 9, 2023

Changes proposed

Upgrade to Gatsby 5, addresses #149

Additional context

Hello. I'm a user of this theme (site: https://devices.esphome.io/), and I decided to try and upgrade everything to the latest package versions.

There were quite a few changes required for the latest packages.

Homepage: Had to rework the homepage because I can not get shadowing to work with gatsby-plugin-mdx. It works similarly to the docs page now.

MDX Features and Plugins: Everything is working now.

Task list

  • Upgrade packages
  • docs page
  • home page
  • mdx plugins
  • advanced code highlighting features
  • documentation updates for homepage

@changeset-bot
Copy link

changeset-bot bot commented May 9, 2023

🦋 Changeset detected

Latest commit: a3135a4

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

This PR includes changesets to release 2 packages
Name Type
@rocketseat/gatsby-theme-docs-core Major
@rocketseat/gatsby-theme-docs Major

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

@tekmaven tekmaven marked this pull request as ready for review May 13, 2023 15:53
@vercel
Copy link

vercel bot commented May 15, 2023

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

Name Status Preview Comments Updated (UTC)
rocketdocs-gatsby-theme-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2023 4:24pm

Copy link
Owner

@jpedroschmitz jpedroschmitz 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 the great work @tekmaven! I'm no longer working with Gatsby, so I'm not sure about every change in the PR, but the project is building and everything is passing, so we should be good to go! ✅

Can I ping you for help in case there are any issues related to this update?

@jpedroschmitz jpedroschmitz merged commit ed4b5b3 into jpedroschmitz:main May 15, 2023
@github-actions github-actions bot mentioned this pull request May 15, 2023
@jpedroschmitz
Copy link
Owner

@tekmaven, could you write a small changelog on how to migrate to the new version? I see there are a few changes, so that would be helpful. You can post it as a comment on #149 as a comment.

@tekmaven
Copy link
Contributor Author

@jpedroschmitz here are some upgrade directions:

  • Follow Gatsby v4 > v5 upgrade guide (including upgrading to Node 18 and updating packages).
  • Move homepage from src/@rocketseat/gatsby-theme-docs/text/index.mdx to src/home/index.mdx and add the homePath: 'src/home' setting in the plugin options.

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.

2 participants