hbstack / site

HB Framework Documentation Site.
https://hbstack.dev/
8 stars 15 forks source link

Show every config in one page #770

Closed TetraTheta closed 4 months ago

TetraTheta commented 4 months ago

It would be nice to see 'All-in-one config page' in the site with those config's default value.

With it, people don't need to navigate every module page for updating their config to latest.

#hugo.yaml
params:
  hb:
    css_bundle_name: hb
    color: light
    debug: false
    js_bundle_name: hb
    logo: images/logo.png
    full_width: false
    header:
      brand: ""
      breakpoint: lg
      full_width: true
      logo_bg: indigo
      menus_alignment: start
      sticky: true

This is breif example for Core Module and Header module.

razonyang commented 4 months ago

It's modular, I don't think user will import all the modules, this is not a good way to go.

TetraTheta commented 4 months ago

That's why I added link for module page to every config key. User can click the link to see if the config is related to their site or not. That AIO page is for simple reference.

Maybe specifying the module with comment would be good for that information, like this:

# hugo.yaml
params:
  hb:
    css_bundle_name: hb # hb
    # ...
    header:
      brand: "" # header
      socials: # header/socials

But since those configs are categorized fairly intuitive, I'm not sure those comment would be actually useful or not.

razonyang commented 4 months ago

But since those configs are categorized fairly intuitive, I'm not sure those comment would be actually useful or not.

I think it's not very helpful.

It may be helpful that to make the evey params to be a heading, so that user can search/locate the parameter, take images.hugomods.com as an example.

image

TetraTheta commented 4 months ago

I think that's good too!