Rspress Roadmap

[sanyuan0704]

💡 We will update the Roadmap content every quarter. Please stay tuned.

Tasks

Tasks

Preview Give feedback

1. [Bug]: HMR not work for sidebar label #231
   🐞 bug +1
   
2. Improve the project cold start performance.
3. [Feature]: support divider type in _meta.json #120
   💡 good first issue +1
   
4. [Bug]: Doc right aside do not contain the title of document fragments #24
   🐞 bug +1
5. Support Badge component in toc
6. Allow to configure prism languages in code highlight part
7. Support Katex syntax
8. Support mermaid plugin in mdx compilation.
9. Support more theme, such as blog theme, etc.
10. Provide back-top plugin to add a back to top effect to the page.
11. Provide google-analytics plugin to integrate Google Analytics into your site to collect site visit data.
12. Provide sitemap plugin to generate sitemap file in build phase.
13. Provide client-redirect to support route redirect in client runtime.
14. Generate API Table for react components automatically.
15. [Feature]: How to Support HTML Writing of Configuration Items #201
    enhancement 👏 PR welcome +2
16. [Feature]: Heading IDs customization support #198
    +0
    
17. Scan the code languages in md(x) files automatically

[jeffwcx]

Are there any plans to add component display features, similar to storybooks?

[sanyuan0704]

Are there any plans to add component display features, similar to storybooks?

Yeah, Rspress has official preview and playground plugin for component development scene.

https://rspress.dev/plugin/official-plugins/preview
https://rspress.dev/plugin/official-plugins/playground

And if you have any need else, welcome to feedback.

[jeffwcx]

I have installed and experienced the writing of the demo. It is very fast and the experience is very good, but there are still some points that can be enhanced.

1. Lack of CodeSandbox, Stackblitz, CodePen support.
2. Only supports react component. It is recommended to support cross-framework component display capabilities, such as Vue components.
3. The ability to extract information from react/vue components and generate API tables

[sanyuan0704]

I have installed and experienced the writing of the demo. It is very fast and the experience is very good, but there are still some points that can be enhanced.

1. Lack of CodeSandbox, Stackblitz, CodePen support.
2. Only supports react component. It is recommended to support cross-framework component display capabilities, such as Vue components.
3. The ability to extract information from react/vue components and generate API tables

Good advice! I will response to the three points:

1. The implement of component display in Rspress does not depend on any external sandbox such as CodeSandbox,Stackblitz, etc. But we will also support the link to jump to the corresponding platform in the future. cc @10Derozan
2. The custom component render process is based on React as well as components in the theme.So we have no plan to support vue component in preview/playground plugin.
3. The ability is under construction and we have integrated react-docgen-typescript and documentation to generate API Table automatically.Stay tuned!

[jeffwcx]

For the second point, maybe you can run instances of other frameworks in the react framework. Storybook also uses this pattern. Maybe I can make a PR later;
For the third point, it would be better to have an interface to connect to other frameworks.

[zoolsher]

@jeffwcx Having cross-framework support as a feature in the framework would be fantastic! looking forward to your PR

[Yukiniro]

Hey guys, what should I do if I want to contribute something such as the badge component for the roadmap?

[sanyuan0704]

#542

[sanyuan0704]

Hey guys, what should I do if I want to contribute something such as the badge component for the roadmap?

@Yukiniro You can first put a issue and link the roadmap. Then you can implement it by pull request and we will review your code as soon as possible.

[iicdii]

Provide google-analytics plugin to integrate Google Analytics into your site to collect site visit data.

Isn't it already available with rsbuild-plugin-google-analytics?

[chenjiahan]

Isn't it already available with rsbuild-plugin-google-analytics?

Thanks, we have updated the roadmap status.

[jxh150535011]

For the second point, maybe you can run instances of other frameworks in the react framework. Storybook also uses this pattern. Maybe I can make a PR later;
For the third point, it would be better to have an interface to connect to other frameworks.

Following your approach, I have implemented the rspress-plugin-vue component to support the Vue framework

[chenjiahan]

Awesome 👍 you can add it to: https://github.com/web-infra-dev/awesome-rspack?tab=readme-ov-file