Skip to content

feat: directly serve library document markdown #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fulopkovacs
Copy link
Contributor

This is a POC PR that lets the user to access the markdown documentation pages by adding .md to the end of the path.

  • /form/latest/docs/framework/react/guides/basic-concepts.md redirects to /api/md/form/latest/docs/framework/react/guides/basic-concepts that serves the markdown version of the documentation page.
Kapture.2025-05-03.at.14.14.36.mp4

Why is it useful?

This feature is useful for using the documentation with LLMs, and was inspired by vite:

For every page you can get the original markdown by replacing the .html extension with .md - e.g.:

https://vite.dev/guide/rolldown
(Posted by Evan You)

This feature would let the user to pass the documentation pages as context to the LLM-s they use for specific versions of tanstack libs, which would make sure that they always get the right information, even if there were breaking changes between versions.

Copy link

netlify bot commented May 3, 2025

Deploy Preview for tanstack ready!

Name Link
🔨 Latest commit f1d6aa4
🔍 Latest deploy log https://app.netlify.com/sites/tanstack/deploys/681ac579d6b11a0008191f54
😎 Deploy Preview https://deploy-preview-396--tanstack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 35 (🟢 up 2 from production)
Accessibility: 95 (no change from production)
Best Practices: 83 (no change from production)
SEO: 77 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@SeanCassiere SeanCassiere changed the title POC for serving the markdown pages (useful for LLMs) feat: directly serve library document markdown May 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants