Releases: oddbird/sassdoc-theme-herman
Releases · oddbird/sassdoc-theme-herman
v1.0.0-alpha.10
- BREAKING: Rename
$json
to$herman
for clearer name-spacing - BREAKING:
_herman-inspect
, and_herman-str-replace
are now considered private functions - BREAKING:
herman-map-compile
always returns inspected (json-ready) values,
and now accepts function args - BREAKING: Remove
herman-add-colors
/-sizes
/-ratios
/-font
from utils - BREAKING: Require Node >= 6.0.0
- NEW: Use
herman-add($key, $map, $args…)
to add maps directly to$herman
,
with optional function/args to compile raw map values - NEW: Use
accoutrement-add($type, $key, $map)
to automate compilation
of accoutrement (color, ratio, size, font) maps,
while adding to both$herman
and the appropriate accoutrement global
($colors
,$ratios
,$sizes
,$fonts
). - NEW:
displayColors
option (type:Array
, default:['hex', 'rgb', 'hsl']
) - CHANGE: Group identical colors in color-palette –
#123 - BUGFIX: Fix blocks with multi-line selectors and custom @name annotations –
#140 - DOCS: Move to
docs/
and include in repo.
minor markup bugfix
v1.0.0-alpha.9 Bump v1.0.0-alpha.9
v1.0.0-alpha.8
- BUGFIX: Remove un-used font files from distribution
- Render sassdoc comments that aren't attached to a Sass block as Markdown
prose. - Preserve the original order of sassdoc comments rather than grouping by type.
v1.0.0-alpha.7
- BUGFIX: Render icon previews in iframes.
- BUGFIX: Adjusted styles for navigation and text.
- BUGFIX: Added styles for blockquotes.
- BREAKING:
minifiedIcons
option and the first argument to the@icons
annotation are both paths relative to the project directory, no longer
relative to thetemplatepath
option.
Bugfixes and style cleanup
- BUGFIX: Style cleanup for code-blocks, examples, and properties
- BUGFIX: UsedBy list is aware of
display.alias
to unlink hidden aliases
v1.0.0-alpha.4
- BREAKING: Move
customHead
option intoherman
options object. - BUGFIX: Return correct promise from theme function (fixes early resolution).
SassDoc Parity
- Use GoogleFonts rather than shipping font files
- Add support for remaining SassDoc annotations:
@throw
,@return
,@output
,@content
,@since
,@deprecated
,@author
- Provide more samples
v1.0.0-alpha.2
- BUGFIX: Show compiled html/css @example even if only one type.
v1.0.0-alpha.1
- Display links on index pages to project home and source, when defined in the project
package.json
–
#91 - Clean up display of parameters and properties – #53 and #49 and #55
- Display source and compiled code (njk and html; scss and css) side-by-side – #65
- Add support for @todo annotation – #18
- Add support for @type annotation – #19
- Add support for @alias (and aliased callback) annotation – #5
- Add support for used-by (@require annotation callbacks).
- Show compiled CSS for
@example scss
annotations – #37 - BREAKING: Nest Herman-specific options under
herman
object in sassdoc configuration, and Sass-specific options underherman.sass
object. - Re-brand with sidebar navigation – #58 and #69.
- Add support for rendering documentation from dependency subprojects – #61.
- BUGFIX: Do not link to internal
@access private
items ifdisplay
option is set toaccess: ['public']
. - BUGFIX: Do not error if missing
herman.subprojects
option – #107. - BUGFIX: Do not error if missing
herman
options – #108.
[DEPRECATED] New design and near-complete features
NOTE: This release includes breaking changes, and has been replaced by v1.0.0-alpha.1.
- Display links on index pages to project home and source, when defined in the project
package.json
–
#91 - Clean up display of parameters and properties – #53 and #49 and #55
- Display source and compiled code (njk and html; scss and css) side-by-side – #65
- Add support for @todo annotation – #18
- Add support for @type annotation – #19
- Add support for @alias (and aliased callback) annotation – #5
- Add support for used-by (@require annotation callbacks).
- Show compiled CSS for
@example scss
annotations – #37 - BREAKING: Nest Herman-specific options under
herman
object in sassdoc configuration, and Sass-specific options underherman.sass
object. - Re-brand with sidebar navigation – #58 and #69.
- Add support for rendering documentation from dependency subprojects – #61.
- BUGFIX: Do not link to internal
@access private
items ifdisplay
option is set toaccess: ['public']
.