astro-d2 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,11 +1,19 @@
 # astro-d2
 
+## 0.8.0
+
+### Minor Changes
+
+- [#41](https://github.com/HiDeoo/astro-d2/pull/41) [`b2d3f4b`](https://github.com/HiDeoo/astro-d2/commit/b2d3f4ba8b1a2aefda7733df67ffe11c4f348d84) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds a configuration option and attribute to add an appendix to diagrams with [tooltips or links](https://d2lang.com/tour/interactive/).
+
 ## 0.7.0
 
 ### Minor Changes
 
 - [#34](https://github.com/HiDeoo/astro-d2/pull/34) [`7028b05`](https://github.com/HiDeoo/astro-d2/commit/7028b0569eab2479808f38e6140a8b3d8a6a8db9) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Adds support for Astro v5, drops support for Astro v4.
 
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Astro is now `5.0.0`.
+
   Please follow the [upgrade guide](https://docs.astro.build/en/guides/upgrade-to/v5/) to update your project.
 
   When using the integration with the [Content Layer API](https://docs.astro.build/en/guides/content-collections) and the [`skipGeneration` option](https://astro-d2.vercel.app/configuration/#skipgeneration) is set to `false`, the integration will automatically invalidate the content layer cache at build time so that all existing diagrams can be generated while ensuring that all removed diagrams are properly cleaned up. This limitation will be removed if and when some upstream technical blockers are resolved.

package/config.ts

@@ -2,6 +2,13 @@ import { z } from 'astro/zod'
 
 export const AstroD2ConfigSchema = z
   .object({
+    /**
+     * Whether to add an appendix to the diagrams with tooltips or links.
+     *
+     * @default false
+     * @see https://d2lang.com/tour/interactive/
+     */
+    appendix: z.boolean().default(false),
     /**
      * Defines the fonts to use for the generated diagrams.
      *

package/libs/attributes.ts

@@ -7,6 +7,13 @@ export const AttributesSchema = z
      * specified interval (in milliseconds).
      */
     animateInterval: z.string().optional(),
+    /**
+     * Overrides the global `appendix` configuration for the diagram.
+     */
+    appendix: z
+      .union([z.literal('true'), z.literal('false')])
+      .optional()
+      .transform((value) => value === 'true'),
     /**
      * The dark theme to use for the diagrams when the user's system preference is set to dark mode.
      *

package/libs/d2.ts

@@ -58,6 +58,10 @@ export async function generateD2Diagram(
     extraArgs.push(`--font-bold=${path.relative(cwd, path.join(url.fileURLToPath(config.root), config.fonts.bold))}`)
   }
 
+  if ((config.appendix && attributes.appendix !== false) || attributes.appendix === true) {
+    extraArgs.push(`--force-appendix`)
+  }
+
   try {
     // The `-` argument is used to read from stdin instead of a file.
     await exec(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-d2",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "license": "MIT",
   "description": "Astro integration and remark plugin to transform D2 Markdown code blocks into diagrams.",
   "author": "HiDeoo <github@hideoo.dev> (https://hideoo.dev)",