Recommending a change in tools used for documentation #193
Replies: 6 comments 1 reply
-
Hi, thanks for the suggestion and I totally agree, the current docs is a SolidJS SPA so no SEO and a pain to maintain. I've looked on what the SolidJS team is doing on their new docs using |
Beta Was this translation helpful? Give feedback.
-
But in my opinion as most of it is markdown only so why not use already well tested tools such as docusaurus,vuepress, astro etc... |
Beta Was this translation helpful? Give feedback.
-
Hi, to prevent creating a similar discussion I allo myself to rebound on @code-withAshish point, the Hope-UI Kbd would lovely feet the documentation with an Algolia searching system like Astro use and a lot of others documentations ! |
Beta Was this translation helpful? Give feedback.
-
Docusaurus and vuepress can't render SolidJS components. I think it's weird that the docs of a component library don't use the library itself. Maybe Astro can be used, but I don't know if css-in-js is supported (it's not mentioned in their docs) |
Beta Was this translation helpful? Give feedback.
-
Yeah, I've planned to look at Algolia free tier too |
Beta Was this translation helpful? Give feedback.
-
I had some problems with Astro and JSX. So i ended up using |
Beta Was this translation helpful? Give feedback.
-
Is your feature request related to a problem? Please describe.
Kind of it's related to the problem of docs not using mdx or markdown for writing documentation, which can make the handling of documentation and website quite hard as i grows.
Describe the solution you'd like
i would like to propose using markdown documentation site generaators such as docusaurus or vuepress or if we want to use solidjs only for some custom components then any specific tool doesn't exist today as they exist for react and vue respectively but i would recommend usage of astro with solidjs in combination with mdx , as it would greatly simplify the writing and maintainence of documentation from the state as it exists today.
Beta Was this translation helpful? Give feedback.
All reactions