feat: generate markdown files during build for LLM consumption #341
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
Automatically generates .md files alongside HTML during static site build. For each MDX/MD page, a corresponding .md file is created in the output directory, preserving JSX components and markdown directives. This enables LLMs to consume documentation in markdown format by accessing URLs like /docs/getting-started.md instead of /docs/getting-started, which is easier for LLMs to parse than HTML. Also updates llms.txt to link directly to .md files instead of HTML pages, providing a better experience for LLM documentation crawlers. Key features: - Converts MDX to markdown using unified/remark pipeline - Preserves JSX components (e.g., <Button>) as-is in output - Preserves markdown directives (e.g., :: tab-group) - Supports both direct files (page.mdx) and index files (page/index.mdx) - Updates llms.txt links to point to .md files - Only runs during static build, no dev server overhead
|
@rogeriochaves is attempting to deploy a commit to the Wevm Team on Vercel. A member of the Team first needs to authorize it. |
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.
Hey there, I'm proposing this change, which we already use on Scenario docs:
https://scenario.langwatch.ai/llms.txt
example md page: https://scenario.langwatch.ai/agent-integration.md
===
Automatically generates .md files alongside HTML during static site build. For each MDX/MD page, a corresponding .md file is created in the output directory, preserving JSX components and markdown directives.
This enables LLMs to consume documentation in markdown format by accessing URLs like /docs/getting-started.md instead of /docs/getting-started, which is easier for LLMs to parse than HTML.
Also updates llms.txt to link directly to .md files instead of HTML pages, providing a better experience for LLM documentation crawlers.