Skip to content

Inkkit 0.3.5

Choose a tag to compare

View all tags
@aicayzer aicayzer released this 28 Oct 23:26
· 12 commits to main since this release
v0.3.5
b4f5822
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Inkkit 0.3.5

Pele replaces Mermaid as the diagram renderer. Existing editor imports, adapters and saved Markdown stay unchanged. Diagram layouts and colors change; the supported diagram families and source restrictions remain the same.

Diagrams

  • Bundle Pele 1.12.0 as the sole renderer for flowchart and graph, sequenceDiagram, classDiagram, stateDiagram and stateDiagram-v2, erDiagram and pie. Keep the mermaid fence language and existing rendering limits.
  • Validate parsed diagram models before rendering and retain DOMPurify sanitization. Unsupported, invalid or refused input keeps its source and the existing diagram-unavailable error contract.
  • Use the Pale palette by default: category colors blend 35% color with 65% background. Neutral surfaces and connectors follow the light or dark editor theme. Set --inkkit-diagram-color-strength: 75% for the stronger Softer option, or override the eight --inkkit-diagram-series-* base colors. Existing background, text and error tokens remain supported.
  • Keep clipboard and print cards white, with the selected color strength and light variants of custom colors. Output embeds its colors and Arial font. Changing the theme does not change saved source or reuse an outdated export palette.
  • Retain accessible diagram titles and descriptions, and give duplicate placements unique SVG IDs. The separate redesign of preview announcements remains deferred.

Rendering lifecycle

Diagram geometry now belongs to the current document. Editing removes obsolete results, document replacement clears them, and editor destruction releases the store. Clipboard and print reuse existing geometry without the previous global 64-entry limit.

Previews yield between diagrams, defer hidden and offscreen cards until they become visible, and cancel obsolete work after edits, replacement or destruction. These changes address the rendering work tracked in #209 and #210.

Package and host migration

The package bundles every runtime dependency. The main entry includes Pele and DOMPurify; @aicayzer/inkkit/core includes neither, addressing #183. The core entry keeps diagram fences as editable source and preserves its clipboard and print fallback behavior.

Hosts update Inkkit and rebuild their offline page and notices. No separate Pele installation is required. Keep the existing editor imports, options and adapters. If the host added a direct Mermaid dependency solely for Inkkit, it can remove that dependency.

Generated third-party notices include Pele's complete license file and its Lucide ISC notice. Both THIRD-PARTY-NOTICES.txt and THIRD-PARTY-NOTICES-FULL.txt remain available with identical contents, so existing host copy recipes keep working. Continue carrying Inkkit's license files and notices for any other dependencies the host bundles.

See Appearance for the palette controls and Embed in a web view for the host build and notice recipe. Host adoption remains separate from package publication.

Assets 2
Loading