Serve markdown to LLMs via Accept header #507
Open
Conversation
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
Add content negotiation to doc routes to serve markdown when Accept: text/markdown or Accept: text/plain is requested. This allows AI coding agents and LLMs to fetch cleaner markdown content instead of HTML, reducing token usage by ~10x. - Add prefersMarkdown() helper to check Accept header - Add ServerRoute handler to both doc routes - Include Vary: Accept header for proper caching 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
❌ Deploy Preview for tanstack failed. Why did it fail? →
|
Extract shared utilities to src/utils/docs.ts: - prefersMarkdown() - Parse Accept header with quality values - createMarkdownResponse() - Create standardized markdown response Both doc routes now use these shared functions, eliminating duplicate code and making maintenance easier. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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.
Summary
This PR adds content negotiation to documentation routes to serve markdown when AI coding agents and LLMs request it via the Accept header.
Like the brother of Jared who saw things more clearly through simplicity, LLMs can process markdown much more efficiently than HTML - reducing token usage by ~10x.
Changes
prefersMarkdown()helper function to parse Accept headers with quality valuesServerRoutehandlers to both doc routes:$libraryId/$version.docs.$.tsx$libraryId/$version.docs.framework.$framework.$.tsxAccept: text/markdownorAccept: text/plainis preferred over HTMLVary: Acceptheader to ensure proper caching of both formatsHow it works
When a request comes in with an Accept header like:
The server will return markdown content instead of rendering the HTML page. This allows tools like Claude Code, Cursor, and other AI agents to fetch cleaner, more parseable documentation.
Testing
Test with:
curl -H "Accept: text/markdown" https://tanstack.com/router/latest/docs/overviewShould return raw markdown instead of HTML.
🤖 Generated with Claude Code