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

Add svg component reference #9911

Merged
merged 11 commits into from
Nov 21, 2024
Merged

Add svg component reference #9911

merged 11 commits into from
Nov 21, 2024

Conversation

natemoo-re
Copy link
Member

Description (required)

This PR adds a new section to the Images guide to introduce using .svg imports as components.

For Astro version: 5.x. See astro PR #12067.

Copy link

netlify bot commented Nov 5, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 1b95758
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/673e62470cd2a200088b05bb
😎 Deploy Preview https://deploy-preview-9911--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

People are going to love this @natemoo-re , thanks for chipping in on the docs for this feature! Some quick comments below! 🎉

src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) 5.0.0-beta labels Nov 5, 2024
@stramel
Copy link
Contributor

stramel commented Nov 7, 2024

Should we also mention the default mode option in the config?

@sarah11918
Copy link
Member

@stramel - yes, we absolutely do need to mention that, too! I had reviewed this before that was in the other PR. When the docs/wording etc. there are confirmed, then we can come back and add here! 🙌

@natemoo-re
Copy link
Member Author

Made the updates that @sarah11918 suggested! Let me know if there's anything else I can do to help get this over the line!

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Thanks @natemoo-re and @stramel !

I also added the stuff for mode and now I will need your help because the section title title and intro paragraph are for "inlining svg" and ... now they're not always inlined! 😅

I think with my suggestions here this is good (correct whatever is necessary!) EXCEPT that we probably need to now be more general about this section. So, maybe this is "SVG components"? And the intro is more like, "Astro provides support for local .svg files as components..." Does that framing sound right?

src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
@astrobot-houston
Copy link
Contributor

astrobot-houston commented Nov 20, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/images.mdx Source changed, localizations will be marked as outdated.
en/reference/experimental-flags/svg.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918
Copy link
Member

Hey @natemoo-re and @stramel !

As I think this feature is likely to be released tomorrow, I made some executive decisions and put this together (moved now to the bottom of the page for easy extraction as this content will soon live on its own page instead of in this guide).

Would love at least a once-over that this content makes sense to you both, but no worries if this gets merged into beta docs with the feature before you've had a chance to review! They are just "beta" docs, and we can change 'em up real fast if and as we need to!

src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved
@sarah11918
Copy link
Member

PIVOT!

I'm going to commit @natemoo-re 's changes and update branch so that we have the new Experimental Flag infrastructure! 🎏

Then, I'll move this into an experimental flag page, and you'll still have a chance to review before tomorrow's merge if necessary. Basically, instead of a heading, we'll need a page title and description, and possible sidebar label if we don't want the sidebar entry to match exactly the page title.

@sarah11918
Copy link
Member

Say hello to your new page!

image

@natemoo-re
Copy link
Member Author

Ooh, looks beautiful @sarah11918! Thanks for handling all the coordination, as always.

Consider this an "author is happy if Team Docs is happy" situation! 💜

@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Nov 20, 2024
@sarah11918 sarah11918 merged commit bdc26ee into 5.0.0-beta Nov 21, 2024
10 checks passed
@sarah11918 sarah11918 deleted the feat/svg branch November 21, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0.0-beta add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants