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

docs: fix formatting related build issue #1256

Closed
wants to merge 1 commit into from

Conversation

HiDeoo
Copy link
Member

@HiDeoo HiDeoo commented Dec 8, 2023

What kind of changes does this PR include?

  • Minor content fixes (broken links, typos, etc.)

Description

This PR fixes a build issue with the docs following the merge of #1250. If I get this right, I think this is what happened:

My assumption was that if some Markdown was rendering fine, applying Prettier would never break it but I guess this is a wrong assumption?

Copy link

changeset-bot bot commented Dec 8, 2023

⚠️ No Changeset found

Latest commit: 4d8fab3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Dec 8, 2023

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

Name Status Preview Updated (UTC)
starlight ✅ Ready (Inspect) Visit Preview Dec 8, 2023 5:01pm

@github-actions github-actions bot added i18n Anything to do with internationalization & translation efforts 📚 docs Documentation website changes labels Dec 8, 2023
@kevinzunigacuellar
Copy link
Sponsor Member

kevinzunigacuellar commented Dec 8, 2023

I've noticed that if there isn't a new line before and after codeblocks the formatter sometimes will break the syntax

Edit: when using the tab component

@HiDeoo
Copy link
Member Author

HiDeoo commented Dec 8, 2023

I've noticed that if there isn't a new line before and after codeblocks the formatter sometimes will break the syntax

Oh, thanks for sharing, I totally did not know about that kind of edge cases 🤔

@HiDeoo
Copy link
Member Author

HiDeoo commented Dec 12, 2023

Fixed by @delucis with 5df5798

@HiDeoo HiDeoo closed this Dec 12, 2023
@delucis
Copy link
Member

delucis commented Dec 12, 2023

Oh boy — sorry for not noticing this PR! I saw the failing build on main and just jumped to getting it passing, sorry. Should have checked for anyone else working on it first!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 docs Documentation website changes i18n Anything to do with internationalization & translation efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants