mediacurrent / theme_generator_8

Yeoman generator for Drupal Themes - lets you quickly set up a Drupal 8 theme with sensible defaults and best practices.
MIT License
100 stars 24 forks source link

Update starter components to include MD files for documentation #58

Closed Tregonia closed 3 years ago

Tregonia commented 4 years ago

The existing setup does not include Markdown files that are used for documenting Patterns. Starter components can include a .md file to illustrate how this can be implemented.

Task

mariohernandez commented 3 years ago

Hey @Tregonia could you provide initial markdown files for the components? I feel most components will be refactored to an extend when used in a new custom theme and the markdown file may become obsolete or out of sync with the new structure of the component. Should we keep this open?

rlahoda commented 3 years ago

I think this can be combined with the updated pattern of using markdown files for hiding files instead of the underscore since the underscore is being depreciated so we can create the markdown files for those initially to hide and start adding descriptions and helpful text to them as we continue

mariohernandez commented 3 years ago

The only pattern in which we are using underscore is the _icons-macro.twig. Can't remember if I already updated it to the new way of hiding it.