Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I want a second layer of "grouping" in the navigation. #228

Closed
mirisuzanne opened this Issue Jan 4, 2018 · 5 comments

Comments

Projects
None yet
2 participants
@mirisuzanne
Copy link
Member

mirisuzanne commented Jan 4, 2018

The sidebar can get quite long, quickly – and often there are logical page-groups such as "configuration", "design tokens", "patterns", 'components", "layouts", etc. I propose handling this in the Herman config, where we already allow group-sorting & naming.

@mirisuzanne mirisuzanne added this to the Backlog milestone Jan 4, 2018

@jgerigmeyer

This comment has been minimized.

Copy link
Member

jgerigmeyer commented Jan 9, 2018

Currently, we just use the standard SassDoc groups option (http://sassdoc.com/configuration/#groups); there is no Herman-specific config here.

How do you propose subgroups would be defined in the config?

@mirisuzanne

This comment has been minimized.

Copy link
Member Author

mirisuzanne commented Jan 10, 2018

I was imagining nested lists:

groups:
  - Configuration:
    - config-colors: _Colors
    - config-fonts: _Fonts
  - Patterns:
    - pattern-buttons: _Buttons
    - pattern-inputs: _Inputs
@jgerigmeyer

This comment has been minimized.

Copy link
Member

jgerigmeyer commented Jan 10, 2018

So you can nest indefinitely, and we determine based on whether the value is a string or array?

I’ll have to look into how the SassDoc groups option works. Sounds like we’d be replacing it with this. I’d hate to require duplication of user settings, but I also don’t want to duplicate a lot of internal SassDoc logic.

@mirisuzanne

This comment has been minimized.

Copy link
Member Author

mirisuzanne commented Jan 10, 2018

I was not imagining indefinite nesting - just adding a single layer. I agree that we should avoid duplicating this.

@jgerigmeyer

This comment has been minimized.

Copy link
Member

jgerigmeyer commented Jan 10, 2018

PR: #233.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.