Releases: oddbird/sassdoc-theme-herman
Releases Β· oddbird/sassdoc-theme-herman
v3.0.1
v3.0.0 - Dependency Changes
- π₯ BREAKING: Move
node-sass
topeerDependencies
- π BUGFIX: Do not require
node-sass
if@example scss
is not used - π INTERNAL: Upgrade dev dependencies
v2.1.0
- π NEW: Add
sass.outputStyle
option (default:expanded
) -- #263 - π BUGFIX: Escape backslashes in
herman-export
string values - π BUGFIX: Fix bug if annotations try to access missing
env.herman
-- #273 - π BUGFIX: Fix bug displaying tabs in
<code>
blocks -- #271 - π BUGFIX: Fix bugs in
customCSS
URL re-writing -- #265, #266 - π INTERNAL: Run tests on Windows -- #270
- π INTERNAL: Upgrade dependencies
v2.0.0
- π NEW: Add support for CSS
@font-face
local()
src in font previews -- #173 - π NEW: Add support for embedded data-URI (
data:...
) font previews -- #197 - π₯ BREAKING: Remove
@font
annotation "formats" option ({woff, woff2}
) -- replaced byformats
key in font Sass map - π₯ BREAKING: Ignore
@font
Sass map top-levelsvgid
option -- replaced by variant-specific nestedsvgid
option - π BUGFIX:
@font
previews for local/embedded fonts now sort@font-face
src according to fontsquirrel generated syntax - π INTERNAL: Use forked version of scss-comment-parser allowing semicolons in documented variable values (e.g. data-URIs) --
#254
v1.1.0
- π NEW: Extend SassDoc groups setting to allow nesting groups in named categories -- #228
- π BUGFIX: Fix
herman-export
including incorrectly escaped quotes (especially when compiled with Ruby Sass) -- #236 - π INTERNAL: Remove deprecated dev-dependency
gulp-util
- π INTERNAL: Upgrade dependencies
v1.0.1
- π DOCS: Document Herman-specific styles and patterns.
- π BUGFIX: Open links within iframe in parent context (
<base target="_parent">
).
π v1.0.0 π
No changes from v1.0.0-rc.8
. Changes since v0.5.5
:
π New Features
- Support for remaining SassDoc annotations:
@throw
,@return
,@output
,@content
,@since
,@deprecated
,@author
,@todo
,@type
,@alias
(and aliased callback),used-by
(@require
annotation callbacks) - New
@font
,@colors
,@sizes
, and@ratios
annotations (replace@preview
annotation) -- #206 - Support for SassDoc [
googleAnalytics
][googleAnalytics] and [trackingCode
][trackingCode] options -- #215 - Site-wide search -- #28
extraDocs
option: adds additional files (parsed as Markdown) -- #117extraLinks
option: adds external links to sidebar nav -- #175displayColors
option: customizes color formats displayed with@colors
annotationcustomHTML
option: HTML to include in rendered@example
annotations (replacesminifiedIcons
option)- Support "prose" SassDoc comments, that aren't attached to a Sass block (parsed as Markdown)
- Sass:
herman-export
mixin -- JSON-export functionality is now built-in Sass-json-export integration should continue to work as expected - Sass:
herman-add($key, $map, $argsβ¦)
function -- adds maps directly to$herman
, with optional function/args to compile raw map values
π₯ Breaking Changes
- Require Node >= 6.0.0
- Remove
@preview
annotation (replaced by new@font
,@colors
,@sizes
, and@ratios
annotations) -- #206 - Remove
@macro
annotation (replaced by@example njk
) -- #182 @icons
annotation now only requires path to a folder of SVG icons: relative to the project directory, no longer relative to thetemplatepath
option -- #47- Herman-specific options are now nested under top-level
herman
object in SassDoc configuration - Remove
minifiedIcons
option (replaced with newcustomHTML
option) - Remove
customHead
option (replaced by multiline@font
annotation) - Sass-specific options are now nested under
herman.sass
object - Remove top-level
templatepath
andnunjucksEnv
options -- now nested under newnunjucks
options object:nunjucks.templatepath
andnunjucks.environment
customCSS
is only included in rendered@example
annotation iframes- Group navigation is now ordered according to config
groups
order -- #150 - Preserve the original order of SassDoc comments, rather than grouping by type
- Sass:
$herman
export map structure is now organized by type, in nested maps:colors
,sizes
,ratios
, andfonts
- Sass:
herman-add
mixin now requires an initial$type
argument, in order to assign the given data to the proper nested data-type map - Sass: Rename
$json
to$herman
for clearer name-spacing - Sass:
_herman-inspect
, and_herman-str-replace
are now considered private functions - Sass:
herman-map-compile
always returns inspected (json-ready) values, and now accepts function args - Sass: Remove
herman-add-colors
/-sizes
/-ratios
/-font
from utils
π Bug Fixes
- Return correct promise from theme function (fixes early resolution)
UsedBy
list is aware ofdisplay.alias
to unlink hidden aliases- Do not link to internal
@access private
items ifdisplay
option is set toaccess: ['public']
- Fix assets referenced with relative urls in client-provided
customCSS
for@example
annotations -- #174 - Fix blocks with multi-line selectors and custom
@name
annotations -- #140 - Fix broken internal links -- #106
- Do not break layout on fonts with single-item stack -- #172
π Polish
- Add attribution/link to Herman/OddBird in nav footer (hidden if
display.watermark
is set tofalse
) -- #154 - Replace marked with markdown-it for Markdown parsing with quote beautification -- #119
- Add "widont" text transformations with typogr
- Pretty-print compiled HTML/Nunjucks with html prettyprinter
- Add Herman logo for default favicon -- #155
- Group identical colors in
@colors
color-palette -- #123 - Display
@example
source and compiled code (njk and html; scss and css) side-by-side -- #65, #37 - 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, #49, #55
- Re-brand with sidebar navigation -- #58, #69
- Various branding and style improvements
π Internal
- Use forked version of CDocParser preserving
///
within comments -- #212 - Use
installJinjaCompat
for default Nunjucks environment - Bundle static assets with Webpack; precompile JS with Babel -- #205
- Do not minify compiled HTML assets -- #186
- Move documentation to
docs/
and include in repo - Flesh out Herman documentation
- Use GoogleFonts rather than shipping font files
- Add 100% test coverage
- Update dependencies
v1.0.0-rc.8
- CHANGE: Use
installJinjaCompat
for default Nunjucks environment. - BUGFIX: Fix prettyPrint for compiled HTML/Nunjucks.
v1.0.0-rc.7
- NEW: Support SassDoc
googleAnalytics
andtrackingCode
options -- #215 - CHANGE: Use forked version of CDocParser preserving
///
within comments -- #212 - BUGFIX: Fix paths to custom assets referenced from
customCSS
.
v1.0.0-rc.6
- BUGFIX: Fix search result page links.