feat: add json-ld schema to docs homepage #739
Merged
Conversation
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
Signed-off-by: amaan-bhati <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 has changed?
Adds JSON‑LD injection to the docs homepage so search engines can parse breadcrumb hierarchy and page metadata.
Emits BreadcrumbList (Home → Docs) and Article schema on the homepage.
Adds
@docusaurus/Headto inject JSON‑LD on the docs landing page.BreadcrumbList schema uses
siteConfig.urlandsiteConfig.baseUrlto generate Home and Docs items.Article schema uses
siteConfig.titleandsiteConfig.tagline, plus the Keploy publisher entity.This PR Resolves : keploy/keploy#3433
Type of change
How Has This Been Tested?
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
npm run buildnothing breaks:How to test
npm run starthttp://localhost:3000/docs/<head>and search for:- Verify the BreadcrumbList has: - Home → Docs - Verify the Article schema includes: - headline from the site title:
- description from the site tagline:
Checklist: