{{!
! Feel free to add more meta or stylesheets. It's up to you.
}}
{{!
! You can access any variable you set in your configuration file from the `view` object.
! Basically your configuration file is passed to the view as the `view` object.
}}
{{view.test_variable}}
{{!
! Data comes with a `byGroupAndType` key which contains the data tree
! with groups as first level (default group is named `undefined`),
! types as second level (`function`, `variable` or `mixin`), items as third level.
! So: `groups > types > items`.
!
_data.byGroupAndType = {
'undefined': {
'function': [ ... ],
'mixin': [ ... ],
'variable': [ ... ],
},
}
!
! For extra informations about the `data` interface, be sure to have a look at the wiki:
! https://github.com/SassDoc/sassdoc/wiki/SassDoc-Data-Interface
}}
{{!
! Groups usually have quite unfriendly names, hence `undefined`. Fortunately, they can be aliased
! from the configuration file of the theme. Then, SassDoc processes it to generate a `groups` object.
! In this object, each group name is mapped to either an alias if specified in the configuration file
! or the same group name. For instance:
!
groups = {
'undefined': 'My Awesome Default Group',
}
!
! To retrieve the alias of a group, use `groups[group_name]`. In this case, `groups['undefined']` will
! return `My Awesome Default Group`.
}}
{{!
! To display our items, we need to:
! 1. Loop over `_data.byGroupAndType` groups
! 2. Loop over types mapped to each group
! 3. Loop over items mapped to each type
}}
{{! 1. Loop over the groups in `_data.byGroupAndType` }}
{{#each _data.byGroupAndType }}
{{! Retrieve group alias if any (else group name) }}
{{groups.[@key]}}
{{! 2. Loop over the types in the current group }}
{{#each this}}
{{! If items to be displayed in type }}
{{#if this}}
{{@key}}
{{! 3. Loop over the items in the current type }}
{{#each this}}
{{! At this point it is up to you to display whatever you want from your items. }}
{{context.name}}
{{/each}}
{{/if}}
{{/each}}
{{/each}}
{{!
! If your theme needs some JavaScript, feel free to create a JS file in `assets/js/` folder
! and include it as follow:
!
!
}}