feat: directly serve library document markdown #396
Merged
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
|
| Name | Link |
|---|---|
| 🔨 Latest commit | 0b7a102 |
SeanCassiere
reviewed
May 3, 2025
app/routes/api/md/$libraryId/$version.docs.framework.$framework.$.ts
Outdated
Show resolved
Hide resolved
SeanCassiere
changed the title
Co-Authored-By: fuko <43729152+fulopkovacs@users.noreply.github.com>
SeanCassiere
force-pushed
the
md-doc-pages
branch
from
1ed02d8 to
0b7a102
Compare
SeanCassiere
approved these changes
May 20, 2025
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.
This is PR lets the user access the markdown format of the documentation pages/guides, by adding a
.mdsuffix to the end of the path.With this change, the following (example) links would work as follows.
/form/latest/docs/framework/react/guides/basic-conceptsserves React SSR'd version of the documentation./pacer/latest/docs/installationserves React SSR'd version of the documentation./form/latest/docs/framework/react/guides/basic-concepts.mdserves the raw markdown for the documentation page./pacer/latest/docs/installation.mdserves the raw markdown for the documentation page.Why is it useful?
This feature is useful for using the documentation with LLMs, and was inspired by
vite:This feature would let the user to pass the documentation pages as context to the LLM-s they use for specific versions of TanStack libraries, which would make sure that they always get the right information, even if there were breaking changes between versions.