Skip to content

Releases: andy820621/nuxt-content-mermaid

v4.0.1

Choose a tag to compare

@github-actions github-actions released this 21 Oct 22:46
1affb96

compare changes

🩹 Fixes

  • Keep error-slot source visible (#150). Source shown by an #error slot or a custom error component is no longer clipped, error content takes the full row when no diagram has rendered yet, and <code> inside rendered HTML labels stays visible. This resolves the 4.0.0 known limitation (#145). The pre-render hiding rule now applies only to a <pre> or <code> placed directly in the default slot: a fallback wrapped in another element is no longer hidden before rendering, so its box can show while its text stays transparent. The rule's selector specificity also rose, so application CSS that overrode the old rule may need a more specific selector.

💅 Refactors

  • Remove versioned names from specs and Mermaid allowlists (#151)

✅ Tests

  • Give browser E2E cases an explicit timeout (#153)

❤️ Contributors

v4.0.0

Choose a tag to compare

@github-actions github-actions released this 21 Oct 18:48
a5656f8

compare changes

⚠️ Breaking Changes

  • Bundle Mermaid ~12.2.0 instead of ~11.17.0 (#146). Mermaid 12 removes flowchart.defaultRenderer, class.defaultRenderer, and state.defaultRenderer from its public configuration types, so object literals report TS2353, and ignores the keys at runtime. Set layout: 'dagre' or layout: 'elk' inside the diagram type's section to keep the per-type choice, or at top level for every supporting diagram type. Development builds warn once per configuration source and field.
  • Adopt Mermaid 12's browser baseline: ES2024, Safari 17.4+, and iOS / iPadOS 17.4+ (#146). This is the package's first explicit browser floor; older browsers are outside the contract. Node.js >=22.19.0, Nuxt ^4.1.0, and @nuxt/content >=3.5.0 <4.0.0 are unchanged.

🚀 Highlights

  • Keep the 3.x rendering direction under Mermaid 12: module defaults select layout: 'dagre', look: 'classic', and the default/dark theme policy, and keep mindmap on cose-bilkent and swimlane on swimlane (#146). Each default can be overridden; diagram spacing and dimensions can still change.
  • ELK now ships inside Mermaid and loads as a separate chunk only when a diagram selects layout: 'elk' (#146).

🩹 Fixes

  • deps: Resolve a single unhead 3 release for the website (#148)

🤖 CI

  • Audit published dependencies before release (#140)
  • Retry Playwright installation once (#142)
  • Allow breaking-change marker in PR titles (#147)

📘 Migration

Follow the v4 migration guide and the 4.x dependency and migration contract. An application's ^3.x range does not receive Mermaid 12; install @barzhsieh/nuxt-content-mermaid@^4 to opt in.

With 4.0.0, 3.x becomes a Frozen Legacy Release: it stays installable but receives no dependency updates, compatibility expansion, features, or ordinary fixes. The three months after 4.0.0 publication form a migration assistance window for documentation, usage guidance, and 4.x defects that block migration.

Known limitation: source shown in an error slot can be clipped by existing CSS (#145). It predates Mermaid 12 and is tracked separately.

❤️ Contributors

v3.0.5

Choose a tag to compare

@github-actions github-actions released this 20 Oct 04:39
6d286f7

compare changes

🚀 Enhancements

  • website: Establish SEO and crawler foundations (#130)

🩹 Fixes

  • Handle missing page configuration during SSR (#132)

📖 Documentation

  • Simplify release workflow (#128)

Upgrade notes

  • After upgrading, stop the Nuxt/Docus app, remove its generated .data/content cache (or the configured local Content cache path), then restart or rebuild. Invalidate restored CI Content caches too. Cached markup from 3.0.4 can retain the old binding and continue causing SSR errors.
  • Separate inline attributes with whitespace, for example {title="x" toolbar.title="y"}. Comma-separated attributes now preserve the original code fence.
  • PNG export: after a network failure, some browsers keep the failed module load, so retrying may still fail until the page is reloaded. SVG export remains available.

❤️ Contributors

v3.0.4

Choose a tag to compare

@github-actions github-actions released this 20 Aug 14:24
ffcbe13

compare changes

🩹 Fixes

  • Scope PNG fonts and preserve download disclosure target (#121)
  • Avoid hydration mismatch in download disclosure IDs (#126)

🏡 Chore

  • Move pnpm settings to workspace config (#116)
  • Rename final compatibility profile to package compatibility pr… (#122)

❤️ Contributors

v3.0.3

Choose a tag to compare

@github-actions github-actions released this 20 Aug 07:07
0b221f0

compare changes

🚀 Enhancements

  • Add customizable built-in control labels (#111)
  • Download Mermaid diagrams as SVG or PNG (#113)

🩹 Fixes

  • Restore focus around diagram presentations (#112)

❤️ Contributors

v3.0.2

Choose a tag to compare

@github-actions github-actions released this 18 Aug 17:04
3a42b8b

compare changes

⚠️ Breaking Changes

  • v3.0.2 is the first npm-published successor to v3.0.0 and carries forward the v3.0.1 removal of the legacy inline Mermaid fence shorthand displayMode. Replace {displayMode="compact"} with Mermaid YAML config:

    ---
    config:
      gantt:
        displayMode: compact
    ---

    Mermaid's official top-level YAML displayMode remains accepted. Unsupported inline attributes preserve the complete original fence instead of being partially transformed.

🩹 Fixes

  • release: Prepare generated Nuxt module types before the package build so pnpm pack succeeds from a clean checkout.
  • release: Use setup-node@v7 without its removed dummy authentication fallback and explicitly disable dependency caching in the OIDC publishing job.

ℹ️ Release Recovery

  • v3.0.1 was tagged but failed deterministic artifact verification before npm publish; no 3.0.1 package or GitHub Release was created. Its tag remains unchanged as the immutable record of that attempt.

❤️ Contributors

v3.0.0

Choose a tag to compare

@github-actions github-actions released this 11 Aug 09:57
b411b3b

v3.0.0

compare changes

⚠️ Breaking Changes

  • Adopt the Nuxt 4 dependency contract: Node.js >=22.19.0, Nuxt ^4.1.0, and @nuxt/content >=3.5.0 <4.0.0 are now required (6f8643e). Nuxt 3 users should remain on the frozen 2.x line.
  • Define the v3 configuration contract and public types (#33): rename the removed mermaidContent alias to contentMermaid, keep enabled in build-time module configuration, and transport only pure data through public runtime configuration.
  • Route configuration authored in Markdown through the pageConfig prop (9507482). Direct component usage continues to use config; supplying both sources is an error.
  • Remove the undocumented package-root transformMermaidCodeBlocks export (#15). Install the module through its default export and let it own Markdown transformation.

🚀 Highlights

  • Add SSR-safe, transactional Mermaid rendering so stale or failed renders cannot replace the latest successfully committed diagram (#5, #24, #35).
  • Isolate configuration by Nuxt application and component invocation, with frozen runtime snapshots and deterministic recovery from reactive source conflicts (#34, #37, #40, #41).
  • Make renderer selection and fallback handoff deterministic, with public diagnostics when renderer resolution fails (#49, #51, #52).

📘 Migration

Follow the v3 migration guide for configuration examples and the dependency and migration contract for the complete 3.x support policy.

❤️ Contributors

v2.2.3

Choose a tag to compare

@andy820621 andy820621 released this 23 Feb 16:55

compare changes

🩹 Fixes

  • Use relative import path and fix TS 5.9 type errors (ff62dc8)

❤️ Contributors

v2.2.2

Choose a tag to compare

@andy820621 andy820621 released this 23 Feb 16:21

compare changes

🩹 Fixes

  • Pre-bundle mermaid CJS deps for pnpm strict mode (50d258f)
  • Add default export (960e7ee)
  • Include missing dayjs duration plugin in optimizeDeps (b47d3fa)

🏡 Chore

✅ Tests

  • Verify mermaid optimizeDeps injection in module setup (d190633)

❤️ Contributors

v2.2.1

Choose a tag to compare

@andy820621 andy820621 released this 31 Dec 10:08

compare changes

🎨 Styles

  • Use :where() for root and dark theme selectors in styles.css (7c33d98)

❤️ Contributors