fix: SEO support for the FxTS documentation site to improve search engine visibility #375
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.
Summary
This PR adds SEO support for the FxTS documentation site to improve search engine visibility.
Fixes #238
Changes
1. API Documentation SEO (Auto-generated)
Modified
website/generate-api-docs/markdown-plugin/src/MarkdownFeature.tsto:descriptionfield to frontmatter automatically2. Guide Pages SEO (Manual)
Added
descriptionfrontmatter to all guide pages:getting-started.mdfunction-composition.mdlazy-evaluation.mdhandle-concurrency.mderror-handling.mdmethod-chaining.mdto-async.mdhow-to-debug.md3. VitePress SEO Meta Tags
Added
transformPageDatahook inwebsite/docs/.vitepress/config.tsto dynamically generate meta tags:og:titleog:descriptionog:typeog:imagetwitter:cardtwitter:titletwitter:descriptiontwitter:imageResult
Before
Google search results showed only the generic description:
After
Each page now has its own unique meta tags: