rspress icon indicating copy to clipboard operation
rspress copied to clipboard

[Feature]: Add the option to init a barebone template

Open YanPes opened this issue 1 year ago • 5 comments

What problem does this feature solve?

When setting up a new rspress page, there is a lot of predefined styling with high specificity. Although this can be good in some use cases, it is cumbersome if you want to fully customize the styling. This needs either overriding predefined styles or creating all elements with custom MDX components.

I would like to have the option to select if I want the default init or a barebone init which strips away all the branding.

What does the proposed API look like?

An additional step when starting the CLI wizard with npm create rspress@latest

Choose your template:

  • default (ready to go, including default look and feel)
  • custom (core functionality without branding and styling)

YanPes avatar Oct 12 '24 08:10 YanPes

This is impossible due to the default theme, you can customize it by yourself.

  • https://rspress.dev/guide/basic/custom-page#customizing-page
  • https://rspress.dev/guide/advanced/custom-theme

We will consider more pluggable designs in future about theme designs.

Timeless0911 avatar Oct 14 '24 03:10 Timeless0911

@Timeless0911 I believe this is a reasonable proposal, currently create-rspress only provides one template, which is not enough. We can refactor create-rspress with https://github.com/rspack-contrib/create-rstack and provide more templates for different use cases.

chenjiahan avatar Oct 14 '24 03:10 chenjiahan

custom (core functionality without branding and styling)

What is without branding and styling mean? Do you want to not use any UI capabilities?

Timeless0911 avatar Oct 14 '24 04:10 Timeless0911

Thank you for your fast replies.

The idea of adding multiple theming options would already help a lot for different scenarios.

My initial idea was treating the theming of rspress a bit like chadcn-ui look and feel. Very minimalistic and basic, almost like a high fidelity wireframe mock.

In the end it is all about improving the DX for the consumers so I really resonate with the idea of adding create-rstack as step wizard.

YanPes avatar Oct 14 '24 06:10 YanPes

Thanks for your detailed explanation, we will enrich more templates for users in different scenarios in the future.

Timeless0911 avatar Oct 14 '24 06:10 Timeless0911