honkit/honkit v7.0.0

Release v7.0.0

on GitHub

Breaking Changes

• Supported browsers: the default theme now targets Chrome / Edge / Firefox 100+ and Safari 15+. Older browsers may not run the scripts of the theme.
• Font settings moved into the default theme (#554): the text no longer moves after the page is shown (CLS 0). gitbook.fontsettings, pluginsConfig.fontsettings and plugins: ["-fontsettings"] work as before.
  • gitbook/@honkit/honkit-plugin-fontsettings/fontsettings.js and website.css are no longer in the output.
  • A custom theme that ships its own _assets/website/theme.js has no font settings.
• @honkit/honkit-plugin-theme is no longer published (#553). Use the default theme (@honkit/honkit-plugin-theme-default).

Notable changes

• Scripts are loaded with defer (#549): the theme and plugin scripts no longer block rendering. Inline scripts that use gitbook.push(), require() or $(fn) keep working.

Performance

The default theme is lighter and the page no longer moves after it is shown.

Layout shift (CLS), docs plugins page    v6.2.6  ██████████████  0.286
                                         v7.0.0                  0
JavaScript (gzip)                        v6.2.6  ███████████     110 KB
                                         v7.0.0  █████           48 KB
First paint (FCP), docs top page         v6.2.6  ███████████     2.11 s
                                         v7.0.0  ████████        1.67 s

• On desktop the score is 100 on all three pages (was 100 / 92 / 100), and CLS is 0 (was 0.031 / 0.181 / 0.039).
• Measured with Lighthouse (mobile, default simulated throttling, gzip, median of 5 runs) against the HonKit docs and a test book on a local static server, v6.2.6 → v7.0.0. The page weight includes 70 KB of icon font.
• With real (DevTools) throttling instead of the simulated one, FCP and LCP stay at about 1.5 s in both versions: the gain there is the layout shift (score 96 / 85 / 97 → 100) and the smaller JavaScript.
• What changed: scripts are loaded with defer (#549), jQuery is no longer used inside the theme scripts (#547), and font settings are applied before the first paint (#554).

What's Changed

Security Fixes

• fix(theme-default): CSP support, focus, scroll restoration, navigation overlap and linkless TOC entries by @azu in #548

Bug Fixes

• fix(theme-default): apply font settings before the first paint, and move them into the theme by @azu in #554

Refactoring

• refactor(theme-default): drop jQuery from the theme scripts and modernize the build by @azu in #547
• refactor(theme-default): replace LESS with plain CSS by @azu in #551
• refactor(theme-default): use const and let instead of var by @azu in #552

Testing

• test(e2e): add Playwright E2E tests (default theme) by @azu in #546

Maintenance

• chore: remove the unused new theme package (@honkit/honkit-plugin-theme) by @azu in #553

CI

• ci: wait until honkit is installable from npm before building the Docker image by @azu in #545

Other Changes

• perf(theme-default): load theme and plugin scripts with defer by @azu in #549

Full Changelog: v6.2.6...v7.0.0