Skip to content

Releases: oddbird/sassdoc-theme-herman

v1.0.0-alpha.10

14 Sep 18:19
Compare
Choose a tag to compare
v1.0.0-alpha.10 Pre-release
Pre-release
  • 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

29 Jun 17:40
Compare
Choose a tag to compare
minor markup bugfix Pre-release
Pre-release
v1.0.0-alpha.9

Bump v1.0.0-alpha.9

v1.0.0-alpha.8

29 Jun 01:51
Compare
Choose a tag to compare
v1.0.0-alpha.8 Pre-release
Pre-release
  • 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

16 Jun 17:52
Compare
Choose a tag to compare
v1.0.0-alpha.7 Pre-release
Pre-release
  • 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 the templatepath option.

Bugfixes and style cleanup

08 Jun 22:25
Compare
Choose a tag to compare
Pre-release
  • 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

02 Jun 20:26
Compare
Choose a tag to compare
v1.0.0-alpha.4 Pre-release
Pre-release
  • BREAKING: Move customHead option into herman options object.
  • BUGFIX: Return correct promise from theme function (fixes early resolution).

SassDoc Parity

31 May 18:15
Compare
Choose a tag to compare
SassDoc Parity Pre-release
Pre-release
  • 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

31 May 15:31
Compare
Choose a tag to compare
v1.0.0-alpha.2 Pre-release
Pre-release
  • BUGFIX: Show compiled html/css @example even if only one type.

v1.0.0-alpha.1

29 May 17:31
Compare
Choose a tag to compare
v1.0.0-alpha.1 Pre-release
Pre-release
  • 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 under herman.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 if display option is set to access: ['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

26 May 23:30
Compare
Choose a tag to compare

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 under herman.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 if display option is set to access: ['public'].