Add .md extension support for documentation pages #899
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 rewrite rule in next.config.js for *.md -> /api/markdown/* - Create middleware to handle Accept: text/markdown header - Create API route that fetches rendered HTML and converts to markdown - Use unified ecosystem (rehype-parse, rehype-remark, remark-gfm) - Extract main content via [data-algolia-page-scope] selector - Tables, code blocks, and links properly converted to GFM markdown
- Remove [data-algolia-lvl0] hidden elements (e.g., 'Components', 'Guides') - Fix remarkStringify strong option: use '*' instead of '**' (library doubles it)
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
lucasmotta
force-pushed
the
feature/md-extension-html-to-markdown
branch
from
1ba4d2d to
7aad014
Compare
chaance
reviewed
Feb 4, 2026
components/PropsTable.tsx
Outdated
| <AccessibleIcon.Root label="Prop description"> | ||
| <InfoCircledIcon /> | ||
| </AccessibleIcon.Root> | ||
| <InfoCircledIcon aria-hidden="true" /> |
Member
There was a problem hiding this comment.
Why the change here? Isn't this what AccessibleIcon already does for us? Markup on the site looks right to me.
Contributor
Author
There was a problem hiding this comment.
Claude doing claude things, just changed it back.
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
Adds support for accessing documentation pages as markdown by appending
.mdto the URL or using theAccept: text/markdownheader. This is useful for AI agents and tools that need to consume documentation in a clean, structured format.How it works
.mdextension (e.g.,/themes/docs/components/button.md)Accept: text/markdownheaderThe implementation:
[data-algolia-page-scope])Filtering
Elements can be excluded from markdown output by adding the
data-md-excludeattribute. Currently used for:Files changed
next.config.js- Added rewrite rule for.mdextensionmiddleware.ts- AddedAccept: text/markdownheader handlingpages/api/markdown/[...path].ts- API route for HTML → Markdown conversioncomponents/CodeBlock.tsx- Addeddata-md-excludeto live previewscomponents/PropsTable.tsx- Addeddata-md-excludeto visually-hidden elementspackage.json- Added dependencies (rehype-remark, remark-stringify, remark-gfm, hast-util-select, oxfmt)