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.

Sign up for GitHub

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

Jump to bottom

Fix invisible tags in MetaTag & Metadata JSDoc #10504

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Fix invisible tags in MetaTag & Metadata JSDoc #10504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1bf673
Fix invisible tags in MetaTag JSDoc
Philzen Apr 23, 2024
177ccd7
Fix invisible tags in MetaData JSDoc
Philzen Apr 23, 2024
29db41b
add changeset entry
Josh-Walker-GM Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changesets/10504.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Fix invisible tags in MetaTag & Metadata JSDoc (#10504) by @Philzen

This change fixes the common pitfall that tags of all kind are not visible in JSDoc view because it will try to interpret them as HTML. Now these tags should be visible when the JSDoc is rendered. See #10504 for more information
4 changes: 2 additions & 2 deletions packages/web/src/components/MetaTags.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ interface MetaTagsProps {
}

/**
* Add commonly used <meta> tags for unfurling/seo purposes
* Add commonly used `<meta>` tags for unfurling/seo purposes
* using the open graph protocol https://ogp.me/
* @example
* <MetaTags title="About Page" ogContentUrl="/static/about-og.png"/>
* @deprecated Please use <Metadata> instead
* @deprecated Please use `<Metadata>` instead
*/
export const MetaTags = (props: MetaTagsProps) => {
const {
Expand Down
2 changes: 1 addition & 1 deletion packages/web/src/components/Metadata.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const propToMetaTag = (
}

/**
* Add commonly used <meta> tags for unfurling/seo purposes
* Add commonly used `<meta>` tags for unfurling/seo purposes
* using the open graph protocol https://ogp.me/
* @example
* <Metadata title="About Page" og={{ image: "/static/about-og.png" }} />
Expand Down
Loading