feat: add antora docs to sitemap.xml#54
Merged
Merged
Conversation
Collaborator
|
Thanks. Note that this isn't a live project at present. I'll merge this change but I'd recommend not working on this for now. Thanks. |
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.
Fixes #18
Problem
The Antora-generated reference manuals under /docs/reference are served as static HTML files but are not included in the Docusaurus-generated sitemap.xml.
Because the sitemap plugin only includes routes known to Docusaurus, the Antora reference pages are currently missing from the sitemap. This prevents search engines from easily discovering and indexing these pages, which negatively impacts SEO.
Solution
This PR adds a post-build step that scans the Antora build output and appends the generated HTML routes under
/docs/referenceto the sitemap.This ensures that Antora-generated documentation pages are included alongside Docusaurus routes in
sitemap.xml.Implementation
The following changes were made to include Antora-generated pages in the sitemap:
Enable sitemap generation
Sitemap generation was enabled in
docusaurus.config.tsso that Docusaurus producesbuild/sitemap.xmlduring the build process.Add a postbuild script that scans the Antora build directory:
scripts/add-antora-to-sitemap.jsThe script:
Recursively scans antora/build/docs/reference
Converts discovered .html files to routes
Appends them to build/sitemap.xml