Move code block titles into comments (i18nIgnore)#3635
Merged
hippotastic merged 4 commits intoJun 30, 2023
Merged
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
sarah11918
approved these changes
Jun 30, 2023
Member
sarah11918
left a comment
There was a problem hiding this comment.
Inspected every English page by hand, and can confirm no wonkiness to any code snippets! 🥳
(I did notice that some snippets that never did have titles maybe should... but that's a story for another day!)
Great work, Hippo! Thanks for being so thorough, and for also tackling these integrations READMES at the source!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of changes does this PR include?
Description
astro: If a frontmatter block is present, a// JS commentis added at the beginning of the frontmatter block. Otherwise, an<!-- HTML comment -->is added at the beginning of the code.markdown/md: If a frontmatter block is present, a# YAML/TOML commentis added at the beginning of the frontmatter block. Otherwise, an<!-- HTML comment -->is added at the beginning of the code.js(x)/ts(x): A// Single-line commentis added at the beginning of the code.xml: Atitle="..."attribute is added to the opening code fence as no title comments are supported insidexmlsnippets yet.src/content/en/guides/integrations-guide. These changes will also be submitted to the source package README files to prevent them from being overwritten later.