Releases: oddbird/sassdoc-theme-herman
Releases · oddbird/sassdoc-theme-herman
v6.0.2
v6.0.1
- 🐛 BUGFIX: Do not overwrite
ctx.emit
method -- #423 - 🏠 INTERNAL: Upgrade dependencies
Full Changelog: v6.0.0...v6.0.1
v6.0.0
🚀 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
inpackage.json
for simplerpkg:
imports.
💥 Breaking Changes
- Require Dart Sass
^1.71.0
for@example scss
annotations, using the new Node.js package importer insass.sassOptions.importers
by default. - Remove custom Sass importer that supported
~
imports for external modules. Replace~
withpkg:
to use the newer Dart Sass Node.js package importer. - Remove
sass.importers
option (usesass.sassOptions.importers
instead). - Remove deprecated
sass.includes
option (usesass.use
instead). - Drop support for Node < 18
🏠 Internal
- Use
sass-embedded
instead ofsass
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
Full Changelog: v5.0.1...v6.0.0
v5.0.1
- 🏠 INTERNAL: Upgrade dependencies
Full Changelog: v5.0.0...v5.0.1
v5.0.0
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 newcustomPreviewCSS
or existingcustomCSS
options. To be included, custom properties must be declared onhtml
,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 toadd()
)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 withcustomCSS
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 existingcustomCSS
options. To be included, declarations must be declared onhtml
,body
, or:root
in the stylesheet set viacustomPreviewCSS
orcustomCSS
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. Thesass.implementation
option is removed, along with support fornode-sass
. - Rename
sass.importer
option tosass.importers
, matching the Dart Sass option. - Remove
sass.includePaths
andsass.outputStyle
options. These are replaced with a newsass.sassOptions
option, which accepts any options that Dart Sass accepts (e.g.loadPaths
orstyle
). 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 toadd()
) - 🚀 NEW:
utilities.each-key()
will pass each key of a map through a given function
- 🚀 NEW:
- 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
New Contributors
- @robsonsobral made their first contribution in #365
- @dvdherron made their first contribution in #383
- @jerivas made their first contribution in #385
Full Changelog: v4.0.2...v5.0.0
v5.0.0-beta.7
- 💥 BREAKING: Rename
customPropertiesCSS
option tocustomPreviewCSS
- 🐛 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 onhtml
,body
, or:root
in the stylesheet set viacustomPreviewCSS
orcustomCSS
settings. (All@font-face
at-rules are included.) - 🏠 INTERNAL: Upgrade dependencies
Full Changelog: v5.0.0-beta.6...v5.0.0-beta.7
v5.0.0-beta.6
- 🐛 BUGFIX: Add missing CSS custom properties for font, ratio, and size previews
Full Changelog: v5.0.0-beta.5...v5.0.0-beta.6
v5.0.0-beta.5
- 💥 BREAKING: Require Dart Sass (
^1.45.0
) for@example scss
annotations, using the updated Dart Sass JavaScript API. Thesass.implementation
option is removed, along with support fornode-sass
. - 💥 BREAKING: Rename
sass.importer
option tosass.importers
, matching the Dart Sass option. - 💥 BREAKING: Remove
sass.includePaths
andsass.outputStyle
options. These are replaced with a newsass.sassOptions
option, which accepts any options that Dart Sass accepts (e.g.loadPaths
orstyle
). 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 existingcustomCSS
options. To be included, custom properties must be declared onhtml
,body
, or:root
. - 🏠 INTERNAL: Replace Bluebird dependency with native promises.
- 🏠 INTERNAL: Upgrade dependencies
Full Changelog: v5.0.0-beta.4...v5.0.0-beta.5
v5.0.0-beta.4
- 🐛 BUGFIX: Add missing styles for color previews
Full Changelog: v5.0.0-beta.3...v5.0.0-beta.4
v5.0.0-beta.3
- 🚀 NEW: Color previews are now rendered in an
<iframe>
which allows them to make use of user-suppliedcustomCSS
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
New Contributors
- @dvdherron made their first contribution in #383
- @jerivas made their first contribution in #385
Full Changelog: v5.0.0-beta.2...v5.0.0-beta.3