Add SEO metadata and sitemap generation for documentation#20
Merged
samuelduchesne merged 3 commits intomainfrom Feb 28, 2026
Merged
Add SEO metadata and sitemap generation for documentation#20samuelduchesne merged 3 commits intomainfrom
samuelduchesne merged 3 commits intomainfrom
Conversation
…, page descriptions - Enhance root landing page with description, canonical, OG, Twitter Card, and JSON-LD - Add generate_robots_txt() to create robots.txt during deployment - Add generate_sitemap() to create sitemap.xml with all version landing pages and per-version page entries from Zensical-generated sitemaps - Wire robots.txt and sitemap generation into deploy_single_version and merge_version_outputs - Add _extract_description() to auto-extract meta descriptions from page content - Update add_front_matter() to include description in YAML front matter - Improve site_description in zensical.toml base config - Enable meta and tags plugins in zensical.toml https://claude.ai/code/session_016RJzLotk8sGXvy9uZE4TxM
Contributor
|
Docs preview for this PR is available at: |
Suppress S314 lint (trusted build output) and apply ruff format. https://claude.ai/code/session_016RJzLotk8sGXvy9uZE4TxM
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
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.
Summary
This PR enhances the documentation site's search engine optimization (SEO) by adding comprehensive metadata, structured data, and sitemap generation. These changes improve discoverability and enable better indexing by search engines.
Key Changes
SEO Metadata & Structured Data
zensical.tomlwith improved site description and enabled meta/tags pluginsSitemap Generation
generate_sitemap()function that createssitemap.xmlwith:Robots.txt
generate_robots_txt()function to createrobots.txtallowing all crawlers and referencing the sitemapPage-Level Descriptions
_extract_description()in markdown postprocessor to intelligently extract meta descriptions from page content:add_front_matter()to include auto-generated descriptions in YAML front matterIntegration
deploy_single_version()andmerge_version_outputs()now call the new sitemap and robots.txt generators to ensure they're created during deploymentImplementation Details
https://claude.ai/code/session_016RJzLotk8sGXvy9uZE4TxM