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

Remove invalid code block language tag in sitemap README #7487

Merged
merged 1 commit into from
Jun 26, 2023

Conversation

delucis
Copy link
Member

@delucis delucis commented Jun 26, 2023

Changes

  • Removes use of txt as a language tag in a code block, which is not valid and causes error logging in docs.
  • Had to use a <!-- prettier-ignore --> comment because otherwise Prettier tries to remove the whitespace between the opening backticks and the metadata docs uses for insertion highlighting and filename.
  • No changeset because in non-docs contexts this change is essentially invisible.

Testing

Docs-only, n/a.

Docs

/cc @withastro/maintainers-docs for feedback!

@delucis delucis requested a review from a team as a code owner June 26, 2023 20:46
@changeset-bot
Copy link

changeset-bot bot commented Jun 26, 2023

⚠️ No Changeset found

Latest commit: d6322ba

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.

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

@github-actions github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jun 26, 2023
Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

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

Weird that prettier removes the whitespace, but this looks like a valid workaround to me!

@delucis
Copy link
Member Author

delucis commented Jun 26, 2023

Thanks for reviewing!

I’m guessing Prettier’s assumption is that the whitespace is a typo between the backticks and the language tag (because our syntax is admittedly nonstandard) and thinks it’s fixing that?

@delucis delucis merged commit 2eca765 into main Jun 26, 2023
@delucis delucis deleted the chris/tiny-readme-tweak branch June 26, 2023 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants