search

ap0nia / eden-query

🙏 type-safe Elysia.js client with powerful asynchronous state management.
https://ap0nia.github.io/eden-query/
MIT License
34 stars 3 forks source link

rewrite documentation #67

Open ap0nia opened 3 weeks ago

ap0nia commented 3 weeks ago

Problem

The documentation takes irredeemably long to build because Vitepress is really sub-optimal at bundling with two-slash for some reason. While this issue can be triaged itself, I noticed that Effect.ts's documentation website does not suffer this same issue when pre-rendering its markdown through Next.js. Furthermore, By using a more efficient markdown (pre) rendering strategy, documentation can actually be made for other frameworks. (Currently, I'm actually unable to create anymore documentation pages with two-slash because I'm hitting memory limits during the build...)

Solution

Pre-render the documentation with SvelteKit. Refer to effect.ts and shadcn-svelte for examples of pre-rendering markdown with relevant plugins.

Project

While re-working the documentation, I should also address all open issues regarding documentation.

52

54

55

BleedingDev commented 1 week ago

I would suggest to go for RsPress for documentation. It's awesome tool. :)