Skip to content

This PR addresses [DOC-1330] Allow SEO Customization issue #473

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

Merged
merged 7 commits into from
Nov 24, 2023

Conversation

FotieMConstant
Copy link
Contributor

chore(.npmrc): add .npmrc file with auto-install-peers=true
feat(api-reference): add support for metaData configuration in ApiReference component
feat(api-reference): add @unhead/schema and unhead as dependencies in package.json

feat(ApiReference.vue): add support for metaData prop and use it to create global head instance and set SEO meta tags

chore(types.ts): import MetaFlatInput from '@unhead/schema'
feat(types.ts): add metaData property to ReferenceConfiguration type

feat(swagger-parser): add vite.config.ts file for configuring Vite build options

Copy link

changeset-bot bot commented Nov 15, 2023

🦋 Changeset detected

Latest commit: 5355d4b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@scalar/api-reference Patch
@scalar/express-api-reference Patch
@scalar/fastify-api-reference Patch
@scalar/hono-api-reference Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

netlify bot commented Nov 15, 2023

Deploy Preview for scalar-deploy-preview ready!

Name Link
🔨 Latest commit 5355d4b
🔍 Latest deploy log https://app.netlify.com/sites/scalar-deploy-preview/deploys/65608516fd370d0009ccd3f6
😎 Deploy Preview https://deploy-preview-473--scalar-deploy-preview.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.

@FotieMConstant
Copy link
Contributor Author

This PR fixes #470 issue

@FotieMConstant FotieMConstant changed the title This PR addresses [DOC-1330] Allow SEO Customization This PR addresses [DOC-1330] Allow SEO Customization fissue Nov 15, 2023
@FotieMConstant FotieMConstant changed the title This PR addresses [DOC-1330] Allow SEO Customization fissue This PR addresses [DOC-1330] Allow SEO Customization issue Nov 15, 2023
Copy link
Member

@hanspagel hanspagel left a comment

Choose a reason for hiding this comment

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

Awesome, thanks for taking the time! We can delete the .npmrc and I’ve added two suggestions to improve the comments. What do you think?

.npmrc Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Fortunately, this is the default already, so we can safely delete the file:

https://pnpm.io/next/npmrc#peer-dependency-settings

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@marclave and i had some issues locally on my end yesterday during a coding session. I equally mentioned there's no need to push this file. just forgot to exclude it, my bad.

ogTitle: 'Page title',
ogImage: 'https://example.com/image.png',
twitterCard: 'summary_large_image',
//Add more...
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
//Add more...
/* Full list of parameters: https://github.com/harlan-zw/zhead/blob/main/src/metaFlat.ts */

Copy link
Contributor Author

@FotieMConstant FotieMConstant left a comment

Choose a reason for hiding this comment

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

remove .npmrc file

.npmrc Outdated
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@marclave and i had some issues locally on my end yesterday during a coding session. I equally mentioned there's no need to push this file. just forgot to exclude it, my bad.

@FotieMConstant
Copy link
Contributor Author

@hanspagel it should be all good now. Thanks for the suggestions

@marclave
Copy link
Member

@hanspagel how are the latest changes, seems good from my review. We just gotta tidy up the merge conflicts :)

@hanspagel
Copy link
Member

Oh, sorry. @FotieMConstant any chance you could resolve the conflicts? We’ll get this in ASAP then.

FotieMConstant and others added 6 commits November 24, 2023 11:56
feat(api-reference): add support for metaData configuration in ApiReference component
feat(api-reference): add @unhead/schema and unhead as dependencies in package.json

feat(ApiReference.vue): add support for metaData prop and use it to create global head instance and set SEO meta tags

chore(types.ts): import MetaFlatInput from '@unhead/schema'
feat(types.ts): add metaData property to ReferenceConfiguration type

feat(swagger-parser): add vite.config.ts file for configuring Vite build options
Yeah this makes more sense. thanks for the suggesting.

Co-authored-by: Hans Pagel <hanspagel@users.noreply.github.com>
@hanspagel
Copy link
Member

Got it! Thanks for the awesome contribution! :)

@hanspagel hanspagel merged commit f2941f5 into scalar:main Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants