Add markdown serving for AI-readable documentation#363
Draft
Conversation
Co-authored-by: gkorland <753206+gkorland@users.noreply.github.com>
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
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.
Implements clean markdown endpoints for all documentation pages to enable better AI tool parsing. Each page becomes available at
URL.md(e.g.,/getting-started/clients.md) with navigation, footers, and theme elements stripped.Changes
_plugins/markdown_generator.rb) - Automatically generates.mdversions during build by creating shadow pages with clean markdown layout_layouts/markdown.html) - Renders page title, description, and content only, no chrome.github/workflows/pages.yml) - Custom build pipeline supporting Jekyll plugins (GitHub Pages default build doesn't support custom plugins)remote_themeto localthemein_config.ymlto enable plugin usageGemfile) - Added just-the-docs and required Jekyll pluginsLimitations
Content negotiation via
Accept: text/markdownheader requires server-side routing unavailable in GitHub Pages static hosting. The.mdURL suffix provides equivalent functionality without server configuration.Example
Original prompt