sassdoc-theme-herman - npm Package Versions

6.0.2: 2024-11-08

• 🐛 BUGFIX: Address Sass deprecation warnings -- #443 & #449
• 🏠 INTERNAL: Upgrade dependencies

6.0.1: 2024-04-22

• 🐛 BUGFIX: Do not overwrite ctx.emit method -- #423
• 🏠 INTERNAL: Upgrade dependencies

6.0.0: 2024-03-01

🚀 New Features

• Add sass.implementation option (string or Dart Sass instance) to specify the Dart Sass implementation to use for @example scss annotations. (default: sass).
• Use faster Dart Sass AsyncCompiler API for @example scss annotations.
• Add exports.sass in package.json for simpler pkg: imports.

💥 Breaking Changes

• Require Dart Sass ^1.71.0 for @example scss annotations, using the new Node.js package importer in sass.sassOptions.importers by default.
• Remove custom Sass importer that supported ~ imports for external modules. Replace ~ with pkg: to use the newer Dart Sass Node.js package importer.
• Remove sass.importers option (use sass.sassOptions.importers instead).
• Remove deprecated sass.includes option (use sass.use instead).
• Drop support for Node < 18

🏠 Internal

• Use sass-embedded instead of sass internally
• Replace "Source Sans Pro" font with "Source Sans 3"
• Upgrade to Yarn v4 (without PnP)
• Add Dependabot for dependency updates going forward
• Upgrade dependencies

5.0.1: 2022-12-14

• 🏠 INTERNAL: Upgrade dependencies

5.0.0: 2022-12-14

No changes from v5.0.0-beta.7. Changes since v4.0.2:

🚀 New Features

• Color previews are now rendered in an <iframe> which allows them to make use of user-supplied CSS custom properties (and a limited subset of Herman styles). Custom properties are made available via the new customPreviewCSS or existing customCSS options. To be included, custom properties must be declared on html, body, or :root.
• Length keywords in @sizes {ruler} maps now display as a border
• Allow utilities.add() to merge data, instead of override
• utilities.each-value() will pass each value of a map through a given function (this is the previous behavior of passing args to add())
• utilities.each-key() will pass each key of a map through a given function
• Add customSourceMap option (default: customCSS option + .map) to allow copying source-map file along with customCSS file
• Font-map variant keys can be comma-separated -- #338
• Add support for non-standard CSS font-weight names -- #250

💥 Breaking Changes

• Font, ratio, size, and color previews are now rendered without user-provided stylesheets (to avoid style conflicts). CSS custom properties and font-related CSS are made available via the new (🚀) customPreviewCSS or existing customCSS options. To be included, declarations must be declared on html, body, or :root in the stylesheet set via customPreviewCSS or customCSS settings. (All @font-face at-rules are included.)
• Require Dart Sass (^1.45.0) for @example scss annotations, using the updated Dart Sass JavaScript API. The sass.implementation option is removed, along with support for node-sass.
• Rename sass.importer option to sass.importers, matching the Dart Sass option.
• Remove sass.includePaths and sass.outputStyle options. These are replaced with a new sass.sassOptions option, which accepts any options that Dart Sass accepts (e.g. loadPaths or style). See the Dart Sass documentation for more details.
• utilities.add() no longer supports map-compilation functions and arguments, since there are two reasonable approaches. Maps that need to be compiled for Herman must now be compiled before they are added. That can still be done using either:
  • 🚀 NEW: utilities.each-value() will pass each value of a map through a given function (this is the previous behavior of passing args to add())
  • 🚀 NEW: utilities.each-key() will pass each key of a map through a given function
• Disable all autofill annotations for comments that Herman treats as "prose" (i.e. separated from documented code by one or more newlines).
• Drop support for Node < 14

🐛 Bug Fixes

• Switch from tinycolor to colorjs.io for color conversions, to fix bug displaying colors that use hue angle notation.

📝 Documentation

• Add samples for @use '~/sassdoc-theme-herman/scss/utilities';

🏠 Internal

• Replace Bluebird dependency with native promises.
• Replace CircleCI, Codecov, and AppVeyor with GitHub Actions
• Include source-maps with Herman JS & CSS assets
• Remove documentation static-site from repository and npm package
• Limit size of NPM package
• Upgrade dependencies

5.0.0-beta.7: 2022-12-07

• 💥 BREAKING: Rename customPropertiesCSS option to customPreviewCSS
• 🐛 BUGFIX: Add missing font-related CSS (e.g. font-family, font-size, @font-face) to color, font, ratio, and size previews. To be included, declarations must be declared on html, body, or :root in the stylesheet set via customPreviewCSS or customCSS settings. (All @font-face at-rules are included.)
• 🏠 INTERNAL: Upgrade dependencies

5.0.0-beta.6: 2022-11-23

• 🐛 BUGFIX: Add missing CSS custom properties for font, ratio, and size previews

5.0.0-beta.5: 2022-11-22

• 💥 BREAKING: Require Dart Sass (^1.45.0) for @example scss annotations, using the updated Dart Sass JavaScript API. The sass.implementation option is removed, along with support for node-sass.
• 💥 BREAKING: Rename sass.importer option to sass.importers, matching the Dart Sass option.
• 💥 BREAKING: Remove sass.includePaths and sass.outputStyle options. These are replaced with a new sass.sassOptions option, which accepts any options that Dart Sass accepts (e.g. loadPaths or style). See the Dart Sass documentation for more details.
• 💥 BREAKING: Font, ratio, size, and color previews are now rendered without user-provided stylesheets (to avoid style conflicts). CSS custom properties are made available via the new (🚀) customPropertiesCSS or existing customCSS options. To be included, custom properties must be declared on html, body, or :root.
• 🏠 INTERNAL: Replace Bluebird dependency with native promises.
• 🏠 INTERNAL: Upgrade dependencies

5.0.0-beta.4: 2022-11-11

• 🐛 BUGFIX: Add missing styles for color previews

5.0.0-beta.3: 2022-11-07

• 🚀 NEW: Color previews are now rendered in an <iframe> which allows them to make use of user-supplied customCSS and a limited subset of Herman styles.
• 🐛 BUGFIX: Switch from tinycolor to colorjs.io for color conversions, to fix bug displaying colors that use hue angle notation.
• 🏠 INTERNAL: Remove documentation from npm package
• 🏠 INTERNAL: Upgrade dependencies
• 🏠 INTERNAL: Replace CircleCI, Codecov, and AppVeyor with GitHub Actions