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

Convert to nextra 3 #1487

Merged
merged 12 commits into from
Oct 9, 2024
Merged

Convert to nextra 3 #1487

merged 12 commits into from
Oct 9, 2024

Conversation

tiffanyqi
Copy link
Collaborator

@tiffanyqi tiffanyqi commented Oct 4, 2024

Honestly, I was looking into Nextra 3 because of breadcrumb linking, however it turns out that a couple of things are improved if we do it this way.

Pros

  1. Increase in performance
  2. Automatic breadcrumb linking (the first on the list)
  3. Clearer code (example: sidebar icons moved directly to meta.ts rather than inside of theme.config)
  4. Catches strange syntax things, for example weird image names

Before
Screenshot 2024-10-04 at 1 07 39 PM

After
Screenshot 2024-10-04 at 1 07 50 PM

Changes necessary to use Nextra 3

(this is mostly covered per commit):

  1. Package changes is the main reason the file is so big
  2. Next.config.js -> next.config.mjs
  3. Convert all _meta.json files to _meta.ts
  4. Convert Card and Tab to Cards.Card and Tabs.Tab

I'm mostly annoyed that there are so many changes that are not retroactive, but at least it wasn't too bad

Copy link

vercel bot commented Oct 4, 2024

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

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2024 9:10pm

@tiffanyqi tiffanyqi marked this pull request as ready for review October 9, 2024 18:56
@tiffanyqi tiffanyqi requested review from a team as code owners October 9, 2024 18:56
@tiffanyqi tiffanyqi requested review from ryancurtis1 and myronkaifung and removed request for a team October 9, 2024 18:56
Copy link
Collaborator

@myronkaifung myronkaifung left a comment

Choose a reason for hiding this comment

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

We should prioritize fixing the code syntax highlighting since it makes the SDK pages a lot harder to read.

Not a blocker for this PR.

@tiffanyqi tiffanyqi merged commit 2a9ef9d into main Oct 9, 2024
7 checks passed
@tiffanyqi tiffanyqi deleted the tiffany-breadcrumbs branch October 9, 2024 21:27
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