Skip to content

feat: serve raw markdown via .md URLs#1447

Closed
21Chani wants to merge 3 commits intosolidjs:mainfrom
21Chani:feat/serve-raw-markdown
Closed

feat: serve raw markdown via .md URLs#1447
21Chani wants to merge 3 commits intosolidjs:mainfrom
21Chani:feat/serve-raw-markdown

Conversation

@21Chani
Copy link

@21Chani 21Chani commented Mar 11, 2026

  • I have read the Contribution guide
  • This PR references an issue (except for typos, broken links, or other minor problems)

Description(required)

This PR adds the ability to access the raw markdown source of any documentation page by appending .md to the URL (e.g. https://docs.solidjs.com/concepts/signals.md).

This is useful for LLM consumption and aligns with the existing llms.txt file. Changes:

  • Vite plugin (serveRawMarkdown) in app.config.ts: Copies .mdx files from src/routes/ to public/ as .md at build time, so they ship as static assets. In dev, also serves them via middleware for live reloading.
  • Updated llms.txt: All URLs now point to .md versions so LLMs can directly fetch raw markdown content.
  • Updated .gitignore: Ignores the generated public/**/*.md files.

Related issues & labels

#1440

Add a Vite plugin that makes raw .mdx source available at .md URLs
(e.g. /concepts/signals.md). In dev, files are served via middleware
and copied to public/. At build time, files are copied to public/ so
they ship as static assets. Also updates llms.txt to point to .md URLs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify
Copy link

netlify bot commented Mar 11, 2026

Deploy Preview for solid-docs ready!

Name Link
🔨 Latest commit 2c1b76c
🔍 Latest deploy log https://app.netlify.com/projects/solid-docs/deploys/69b1c5614db3950008c25532
😎 Deploy Preview https://deploy-preview-1447--solid-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@davedbase
Copy link
Member

Would it make more sense to incorporate this into SolidBase directly?

@21Chani
Copy link
Author

21Chani commented Mar 11, 2026

Would it make more sense to incorporate this into SolidBase directly?

Hmmm, That would actually make sense yeah, I can work on something for it there and bring it here later on this week.

For a quick feature I believe we could ship as a bandaid it if good just for the time being, what do you think?

@davedbase
Copy link
Member

Would it make more sense to incorporate this into SolidBase directly?

Hmmm, That would actually make sense yeah, I can work on something for it there and bring it here later on this week.

For a quick feature I believe we could ship as a bandaid it if good just for the time being, what do you think?

Let's leave it for now and test/verify it for docs -- thank you for making this possible.

It's a good solution for the time being but I don't want to assume the SolidBase team would have a different solution or not.

Glad to have a solution finally :)

@21Chani
Copy link
Author

21Chani commented Mar 11, 2026

With something like

Would it make more sense to incorporate this into SolidBase directly?

Hmmm, That would actually make sense yeah, I can work on something for it there and bring it here later on this week.
For a quick feature I believe we could ship as a bandaid it if good just for the time being, what do you think?

Let's leave it for now and test/verify it for docs -- thank you for making this possible.

It's a good solution for the time being but I don't want to assume the SolidBase team would have a different solution or not.

Glad to have a solution finally :)

I believe the solution would be very similar honestly. I will start studying their repo as soon as I get a bit more of free time.

But just knowing that accessing .md would be possible it make things easier.
Example: https://deploy-preview-1447--solid-docs.netlify.app/concepts/intro-to-reactivity.md 🙏🏽

For very complex tasks my agents seems to struggle still in solidjs, something that doesn't happen on react anymore.
Part of that I believe it's because docs could be more friendly to them

@LadyBluenotes
Copy link
Member

Hi @21Chani, thanks for putting the time into this.

We really appreciate the effort here. For now, we’re going to close this so we can make sure it’s implemented properly on our side. There are a few things that should be landing soon, as I'd mentioned in the issue you created #1447, and those will move us closer to the direction you're suggesting.

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.

3 participants