Enable .md extension access for raw markdown source#2476
Draft
leighmcculloch wants to merge 10 commits into
Draft
Enable .md extension access for raw markdown source#2476leighmcculloch wants to merge 10 commits into
leighmcculloch wants to merge 10 commits into
Conversation
|
Preview is available here: |
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
1 participant
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
Add nginx configuration to intercept requests ending in .md, strip the extension, and proxy to the original host with an Accept: text/markdown header. This enables any documentation URL to be fetched with a .md extension to retrieve the raw markdown source instead of rendered HTML, leveraging Cloudflare's native markdown feature to serve the appropriate content type.
Why
The markdown extension allows documentation to be more accessible to agents and tools that need raw markdown source, particularly those making requests to Cloudflare which can detect the Accept: text/markdown header and return unrendered markdown. This is useful for indexing, processing, and integration scenarios where the structured markdown format is needed rather than the compiled HTML representation.
Follow up
Update llms.txt to link to documentation URLs with the .md extension so that LLMs and agents accessing the documentation can retrieve raw markdown source directly.