@d10f/asciidoc-astro-loader 0.0.16 → 0.2.0

package/README.md

@@ -27,7 +27,8 @@ Install the package from `npm`:
 And import the loader function inside your `content.config.ts` file to define a new collection:
 
 ```ts
-import { defineCollection, z } from "astro:content";
+import { defineCollection } from "astro:content";
+import { z } from 'astro/zod';
 import { asciidocLoader } from "asciidoc-astro-loader";
 
 const blog = defineCollection({
@@ -93,7 +94,7 @@ const blog = defineCollection({
 });
 ```
 
-### Shiki Trasnformers
+### Shiki Transformers
 
 One of the coolest features from Shiki are [transformers](https://shiki.style/guide/transformers). You can provide a list of the transformers that you want to use at the loader configuration:
 
@@ -352,18 +353,27 @@ Using a converter might make more sense if you need to keep some state as the do
 
 ## Example
 
-This is an example taken from my own website to showcase how to use it in a real world setting. This configuration uses a custom converter, a custom Shiki transformer and points to a folder where custom templates are found:
+This is an example taken from my own website to showcase how to use it in a real world setting:
 
 ```ts
 const blog = defineCollection({
 	loader: asciidocLoader({
 		base: 'src/content/blog',
+		images: {
+			imageUrl: '/',
+		},
 		document: {
 			template: './src/templates',
-			converters: [admonitionConverter()],
+			converters: [
+				admonitionConverter(),
+				xrefConverter()
+			],
 		},
 		syntaxHighlighting: {
-			theme: 'catppuccin-frappe',
+			theme: {
+				light: 'catppuccin-latte',
+				dark: 'catppuccin-frappe',
+			},
 			transformers: [
 				transformerNotationDiff(),
 				transformerNotationErrorLevel(),
@@ -372,6 +382,9 @@ const blog = defineCollection({
 				transformerPrompt({
 					langs: {
 						console: '$',
+						prolog: {
+							hideBreak: true,
+						},
 					},
 					cssClasses: 'unselectable mr-2 opacity-50',
 				}),
@@ -381,10 +394,38 @@ const blog = defineCollection({
 			},
 		},
 	}),
-	schema: z.object({
-		doctitle: z.string(),
-		description: z.string(),
-		revdate: z.coerce.date(),
-	}),
+	schema: z
+		.object({
+			doctitle: z.string(),
+			description: z.string(),
+			revdate: z.coerce.date(),
+			keywords: z.string().transform((t) => t.split(', ')),
+			technologies: z.string().transform((t) => t.split(' ')),
+			series: z.string().optional(),
+			'series-prev': z.string().optional(),
+			'series-next': z.string().optional(),
+			'series-description': z.string().optional(),
+		})
+		.transform(({ doctitle, revdate, ...rest }) => ({
+			title: doctitle,
+			createdAt: revdate,
+			...rest,
+		})),
 });
 ```
+
+This configuration uses a couple of custom converters, a custom Shiki transformer and points to a folder where custom templates are found.
+
+The first converter applies a simple CSS rule so that admonitions are placed on either side of the main document, in an alternate fashion.
+
+The other converter is a little helper to rectify cross-reference links to other documents. I created it because cross-reference in AsciiDoc works by referencing a filename, whereas Astro uses the post title as the URL slug, which makes more sense in the context of the web. This converter handles the conversion so that I can keep things organized neatly based on what makes more sense: use filenames in the file system, and URL slugs in the web.
+
+As for the custom Shiki transformer, that's just so that I control how code snippets look like when there's either a prefix expected, or when multi-line is supported. The classic example of this are console commands, but REPL interpreters are also a good example.
+
+Here you can see it in action with a command that is written over multiple lines for clarity (horizontal overflow not shown here):
+
+![A ffmpeg command written over multiple lines showing only a single prompt](./assets/code-snippet-transformer-console.avif)
+
+Notice the escaping of the newline character, which you might want to omit with the `hideBreak` option. This is useful to distinguish code from REPL interpreters:
+
+![A Prolog interpreter running a command that spans over multiple lines](./assets/code-snippet-transformer-prolog.avif)

package/dist/{chunk-5LUVP7HW.js → chunk-S7W7VGV4.js}

@@ -5,6 +5,8 @@ var AbstractEngine = class {
     this._extensions = _extensions;
     this.templateList = /* @__PURE__ */ new Map();
   }
+  _name;
+  _extensions;
   templateList;
   /**
    * Returns the given name to this template engine.

package/dist/{index-C1F2jTPD.d.cts → index-B1d5alka.d.cts}

@@ -7,110 +7,37 @@ type DocumentOptions = RequiredOptions['document'];
 type PreambleOptions = RequiredOptions['preamble'];
 declare const loaderOptionsSchema: z.ZodObject<{
     base: z.ZodString;
+    images: z.ZodOptional<z.ZodObject<{
+        imageDir: z.ZodOptional<z.ZodString>;
+        imageUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
     document: z.ZodDefault<z.ZodObject<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+        mode: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
+        template: z.ZodPipe<z.ZodDefault<z.ZodString>, z.ZodTransform<string, string>>;
         recursive: z.ZodDefault<z.ZodBoolean>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    syntaxHighlighting: z.ZodDefault<z.ZodEffects<z.ZodObject<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
+    }, z.core.$loose>>;
+    syntaxHighlighting: z.ZodDefault<z.ZodPipe<z.ZodObject<{
+        theme: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
             light: z.ZodString;
             dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, z.core.$catchall<z.ZodString>>]>, z.ZodTransform<{
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, string | {
+            [x: string]: string;
             light: string;
             dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
+        }>>>;
         defaultColor: z.ZodDefault<z.ZodString>;
         cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
+        mergeWhitespaces: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodLiteral<"never">]>>;
+        tabindex: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
         callouts: z.ZodOptional<z.ZodObject<{
             cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>, {
+        }, z.core.$strip>>;
+    }, z.core.$loose>, z.ZodTransform<{
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -124,60 +51,14 @@ declare const loaderOptionsSchema: z.ZodObject<{
         } & {
             [other: string]: string;
         };
-    }, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+    }, {
+        [x: string]: unknown;
+        theme: {
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    preamble: z.ZodDefault<z.ZodObject<{
-        tableOfContents: z.ZodDefault<z.ZodBoolean>;
-        maxLevel: z.ZodDefault<z.ZodNumber>;
-        position: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
-    }, "strip", z.ZodTypeAny, {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    }, {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    base: string;
-    document: {
-        mode: "safe" | "unsafe";
-        template: string;
-        recursive: boolean;
-    } & {
-        [k: string]: unknown;
-    };
-    syntaxHighlighting: {
+        };
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -185,62 +66,13 @@ declare const loaderOptionsSchema: z.ZodObject<{
         callouts?: {
             cssClasses?: string | undefined;
         } | undefined;
-        themes: {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        };
-    };
-    preamble: {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    };
-}, {
-    base: string;
-    document?: z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    syntaxHighlighting?: z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    preamble?: {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    } | undefined;
-}>;
+    }>>>;
+    preamble: z.ZodDefault<z.ZodObject<{
+        tableOfContents: z.ZodDefault<z.ZodBoolean>;
+        maxLevel: z.ZodDefault<z.ZodNumber>;
+        position: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 
 declare abstract class AbstractEngine {
     private _name;
@@ -420,6 +252,30 @@ type AsciidocLoader = {
          */
         templateEngines: Array<AbstractEngine & AsciidocTemplate>;
     }>;
+    /**
+     * Options related to images and their location while parsing documents
+     */
+    images?: Partial<{
+        /**
+         * Path to the directory where images are stored. This is a global
+         * setting that applies to all documents that _do not_ already have
+         * an imagesdir attribute set.
+         *
+         * Make use of templates or converters for granuar control over this
+         * attribute on individua documents.
+         *
+         * @see https://docs.asciidoctor.org/pdf-converter/latest/image-paths-and-formats/#imagesdir
+         */
+        imagesDir?: string;
+        /**
+         * Path relative to the base URL of the site that will be used to
+         * resolve image src attributes. The base URL is configured via the
+         * Astro configuration file.
+         *
+         * @see https://docs.astro.build/en/reference/configuration-reference/#site
+         */
+        imageUrl?: string;
+    }>;
     /**
      * Options provided for the output of the preamble section, when
      * there is one present in the parsed document.
@@ -546,4 +402,4 @@ interface RawTemplate {
     renderString(content: string, options?: Record<string, unknown>): string;
 }
 
-export { type AsciidocLoader as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactoryFn as S, type TemplateModule as T, type AsciidocTemplate as a, AbstractEngine as b, type ShikiTransformerFactory as c };
+export { AbstractEngine as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactory as S, type TemplateModule as T, type AsciidocLoader as a, type AsciidocTemplate as b, type ShikiTransformerFactoryFn as c };

package/dist/{index-C1F2jTPD.d.ts → index-B1d5alka.d.ts}

@@ -7,110 +7,37 @@ type DocumentOptions = RequiredOptions['document'];
 type PreambleOptions = RequiredOptions['preamble'];
 declare const loaderOptionsSchema: z.ZodObject<{
     base: z.ZodString;
+    images: z.ZodOptional<z.ZodObject<{
+        imageDir: z.ZodOptional<z.ZodString>;
+        imageUrl: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
     document: z.ZodDefault<z.ZodObject<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
+        mode: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
+        template: z.ZodPipe<z.ZodDefault<z.ZodString>, z.ZodTransform<string, string>>;
         recursive: z.ZodDefault<z.ZodBoolean>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    syntaxHighlighting: z.ZodDefault<z.ZodEffects<z.ZodObject<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
+    }, z.core.$loose>>;
+    syntaxHighlighting: z.ZodDefault<z.ZodPipe<z.ZodObject<{
+        theme: z.ZodDefault<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
             light: z.ZodString;
             dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, z.core.$catchall<z.ZodString>>]>, z.ZodTransform<{
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+        }, string | {
+            [x: string]: string;
             light: string;
             dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
+        }>>>;
         defaultColor: z.ZodDefault<z.ZodString>;
         cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
+        mergeWhitespaces: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodLiteral<"never">]>>;
+        tabindex: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
         callouts: z.ZodOptional<z.ZodObject<{
             cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>, {
+        }, z.core.$strip>>;
+    }, z.core.$loose>, z.ZodTransform<{
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -124,60 +51,14 @@ declare const loaderOptionsSchema: z.ZodObject<{
         } & {
             [other: string]: string;
         };
-    }, z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
+    }, {
+        [x: string]: unknown;
+        theme: {
             light: string;
             dark: string;
         } & {
             [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough">>>;
-    preamble: z.ZodDefault<z.ZodObject<{
-        tableOfContents: z.ZodDefault<z.ZodBoolean>;
-        maxLevel: z.ZodDefault<z.ZodNumber>;
-        position: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
-    }, "strip", z.ZodTypeAny, {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    }, {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    base: string;
-    document: {
-        mode: "safe" | "unsafe";
-        template: string;
-        recursive: boolean;
-    } & {
-        [k: string]: unknown;
-    };
-    syntaxHighlighting: {
+        };
         defaultColor: string;
         cssVariablePrefix: string;
         mergeWhitespaces: boolean | "never";
@@ -185,62 +66,13 @@ declare const loaderOptionsSchema: z.ZodObject<{
         callouts?: {
             cssClasses?: string | undefined;
         } | undefined;
-        themes: {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        };
-    };
-    preamble: {
-        tableOfContents: boolean;
-        maxLevel: number;
-        position: "before" | "after";
-    };
-}, {
-    base: string;
-    document?: z.objectInputType<{
-        mode: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"safe">, z.ZodLiteral<"unsafe">]>>;
-        template: z.ZodEffects<z.ZodDefault<z.ZodString>, string, string | undefined>;
-        recursive: z.ZodDefault<z.ZodBoolean>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    syntaxHighlighting?: z.objectInputType<{
-        theme: z.ZodDefault<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, "strip", z.ZodString, z.objectOutputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">, z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>]>, {
-            light: string;
-            dark: string;
-        } & {
-            [other: string]: string;
-        }, string | z.objectInputType<{
-            light: z.ZodString;
-            dark: z.ZodString;
-        }, z.ZodString, "strip">>>;
-        defaultColor: z.ZodDefault<z.ZodString>;
-        cssVariablePrefix: z.ZodDefault<z.ZodString>;
-        mergeWhitespaces: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodLiteral<"never">]>>;
-        tabindex: z.ZodDefault<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodLiteral<false>]>>;
-        callouts: z.ZodOptional<z.ZodObject<{
-            cssClasses: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            cssClasses?: string | undefined;
-        }, {
-            cssClasses?: string | undefined;
-        }>>;
-    }, z.ZodTypeAny, "passthrough"> | undefined;
-    preamble?: {
-        tableOfContents?: boolean | undefined;
-        maxLevel?: number | undefined;
-        position?: "before" | "after" | undefined;
-    } | undefined;
-}>;
+    }>>>;
+    preamble: z.ZodDefault<z.ZodObject<{
+        tableOfContents: z.ZodDefault<z.ZodBoolean>;
+        maxLevel: z.ZodDefault<z.ZodNumber>;
+        position: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"before">, z.ZodLiteral<"after">]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 
 declare abstract class AbstractEngine {
     private _name;
@@ -420,6 +252,30 @@ type AsciidocLoader = {
          */
         templateEngines: Array<AbstractEngine & AsciidocTemplate>;
     }>;
+    /**
+     * Options related to images and their location while parsing documents
+     */
+    images?: Partial<{
+        /**
+         * Path to the directory where images are stored. This is a global
+         * setting that applies to all documents that _do not_ already have
+         * an imagesdir attribute set.
+         *
+         * Make use of templates or converters for granuar control over this
+         * attribute on individua documents.
+         *
+         * @see https://docs.asciidoctor.org/pdf-converter/latest/image-paths-and-formats/#imagesdir
+         */
+        imagesDir?: string;
+        /**
+         * Path relative to the base URL of the site that will be used to
+         * resolve image src attributes. The base URL is configured via the
+         * Astro configuration file.
+         *
+         * @see https://docs.astro.build/en/reference/configuration-reference/#site
+         */
+        imageUrl?: string;
+    }>;
     /**
      * Options provided for the output of the preamble section, when
      * there is one present in the parsed document.
@@ -546,4 +402,4 @@ interface RawTemplate {
     renderString(content: string, options?: Record<string, unknown>): string;
 }
 
-export { type AsciidocLoader as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactoryFn as S, type TemplateModule as T, type AsciidocTemplate as a, AbstractEngine as b, type ShikiTransformerFactory as c };
+export { AbstractEngine as A, type CustomConverterFactoryFn as C, type FilesystemTemplate as F, type NodeContext as N, type RawTemplate as R, type ShikiTransformerFactory as S, type TemplateModule as T, type AsciidocLoader as a, type AsciidocTemplate as b, type ShikiTransformerFactoryFn as c };

package/dist/index.cjs

@@ -67,6 +67,7 @@ var BaseConverter = class {
     this.customConverters = /* @__PURE__ */ new Map();
     this.templateEngine = void 0;
   }
+  defaultConverter;
   customConverters;
   templateEngine;
   /**
@@ -297,6 +298,9 @@ var AsciidocDocument = class {
       return acc.add(lang);
     }, /* @__PURE__ */ new Set());
   }
+  setAttribute(attribute, value) {
+    this.document.setAttribute(attribute, value);
+  }
   convert(converters = [], templateEngine) {
     converters.forEach((converter) => {
       this.baseConverter.register(converter);
@@ -318,6 +322,8 @@ var AbstractEngine = class {
     this._extensions = _extensions;
     this.templateList = /* @__PURE__ */ new Map();
   }
+  _name;
+  _extensions;
   templateList;
   /**
    * Returns the given name to this template engine.
@@ -534,8 +540,13 @@ var preambleOptionsSchema = import_zod3.z.object({
   maxLevel: 3,
   position: "after"
 });
+var imagesOptionsSchema = import_zod3.z.object({
+  imageDir: import_zod3.z.optional(import_zod3.z.string()),
+  imageUrl: import_zod3.z.optional(import_zod3.z.string())
+}).optional();
 var loaderOptionsSchema = import_zod3.z.object({
   base: import_zod3.z.string(),
+  images: imagesOptionsSchema,
   document: documentOptionsSchema,
   syntaxHighlighting: shikiOptionsSchema,
   preamble: preambleOptionsSchema
@@ -682,7 +693,13 @@ function asciidocLoader(_options) {
       const { config, logger, watcher } = loaderContext;
       const root = config.root.pathname;
       const base = options.base.startsWith(".") ? (0, import_node_fs4.realpathSync)(options.base) : root + options.base;
-      const docs = (0, import_node_fs4.readdirSync)(base, "utf8").filter((file) => file.match(/(?:\.a(?:scii)?doc)$/)).map((filename) => new AsciidocDocument(`${base}/${filename}`));
+      const docs = (0, import_node_fs4.readdirSync)(base, "utf8").filter((file) => file.match(/(?:\.a(?:scii)?doc)$/)).map((filename) => {
+        const doc = new AsciidocDocument(`${base}/${filename}`);
+        if (options.images?.imageUrl) {
+          doc.setAttribute("imagesdir", options.images.imageUrl);
+        }
+        return doc;
+      });
       if (docs.length === 0) {
         logger.warn("No documents found for this collection.");
         return;
@@ -739,6 +756,12 @@ function asciidocLoader(_options) {
         watcher.on("change", async (changedPath) => {
           if (changedPath.match(watchedFileRegExp)) {
             const newDoc = new AsciidocDocument(changedPath);
+            if (options.images?.imageUrl) {
+              newDoc.setAttribute(
+                "imagesdir",
+                options.images.imageUrl
+              );
+            }
             await setDocument(
               newDoc,
               converters,

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-C1F2jTPD.cjs';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-C1F2jTPD.cjs';
+import { a as AsciidocLoader } from './index-B1d5alka.cjs';
+export { b as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-B1d5alka.cjs';
 export { transformAsciidocCallout, transformerPrompt } from './lib/shiki/transformers/index.cjs';
 import 'shiki';
 import 'asciidoctor';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { LoaderContext } from 'astro/loaders';
-import { A as AsciidocLoader } from './index-C1F2jTPD.js';
-export { a as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-C1F2jTPD.js';
+import { a as AsciidocLoader } from './index-B1d5alka.js';
+export { b as AsciidocTemplate, C as CustomConverterFactoryFn, F as FilesystemTemplate, N as NodeContext, R as RawTemplate } from './index-B1d5alka.js';
 export { transformAsciidocCallout, transformerPrompt } from './lib/shiki/transformers/index.js';
 import 'shiki';
 import 'asciidoctor';

package/dist/index.js

@@ -13,7 +13,7 @@ import {
   HandlebarsEngine,
   NunjucksEngine,
   TemplateStr
-} from "./chunk-5LUVP7HW.js";
+} from "./chunk-S7W7VGV4.js";
 
 // src/loader.ts
 import { readdirSync as readdirSync2, realpathSync } from "fs";
@@ -29,6 +29,7 @@ var BaseConverter = class {
     this.customConverters = /* @__PURE__ */ new Map();
     this.templateEngine = void 0;
   }
+  defaultConverter;
   customConverters;
   templateEngine;
   /**
@@ -259,6 +260,9 @@ var AsciidocDocument = class {
       return acc.add(lang);
     }, /* @__PURE__ */ new Set());
   }
+  setAttribute(attribute, value) {
+    this.document.setAttribute(attribute, value);
+  }
   convert(converters = [], templateEngine) {
     converters.forEach((converter) => {
       this.baseConverter.register(converter);
@@ -343,8 +347,13 @@ var preambleOptionsSchema = z3.object({
   maxLevel: 3,
   position: "after"
 });
+var imagesOptionsSchema = z3.object({
+  imageDir: z3.optional(z3.string()),
+  imageUrl: z3.optional(z3.string())
+}).optional();
 var loaderOptionsSchema = z3.object({
   base: z3.string(),
+  images: imagesOptionsSchema,
   document: documentOptionsSchema,
   syntaxHighlighting: shikiOptionsSchema,
   preamble: preambleOptionsSchema
@@ -392,7 +401,13 @@ function asciidocLoader(_options) {
       const { config, logger, watcher } = loaderContext;
       const root = config.root.pathname;
       const base = options.base.startsWith(".") ? realpathSync(options.base) : root + options.base;
-      const docs = readdirSync2(base, "utf8").filter((file) => file.match(/(?:\.a(?:scii)?doc)$/)).map((filename) => new AsciidocDocument(`${base}/${filename}`));
+      const docs = readdirSync2(base, "utf8").filter((file) => file.match(/(?:\.a(?:scii)?doc)$/)).map((filename) => {
+        const doc = new AsciidocDocument(`${base}/${filename}`);
+        if (options.images?.imageUrl) {
+          doc.setAttribute("imagesdir", options.images.imageUrl);
+        }
+        return doc;
+      });
       if (docs.length === 0) {
         logger.warn("No documents found for this collection.");
         return;
@@ -449,6 +464,12 @@ function asciidocLoader(_options) {
         watcher.on("change", async (changedPath) => {
           if (changedPath.match(watchedFileRegExp)) {
             const newDoc = new AsciidocDocument(changedPath);
+            if (options.images?.imageUrl) {
+              newDoc.setAttribute(
+                "imagesdir",
+                options.images.imageUrl
+              );
+            }
             await setDocument(
               newDoc,
               converters,

package/dist/lib/asciidoc/converters/index.d.cts

@@ -1,5 +1,5 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-C1F2jTPD.cjs';
+import { C as CustomConverterFactoryFn, c as ShikiTransformerFactoryFn } from '../../../index-B1d5alka.cjs';
 import 'asciidoctor';
 import 'astro/zod';
 

package/dist/lib/asciidoc/converters/index.d.ts

@@ -1,5 +1,5 @@
 import { ShikiTransformer } from 'shiki';
-import { C as CustomConverterFactoryFn, S as ShikiTransformerFactoryFn } from '../../../index-C1F2jTPD.js';
+import { C as CustomConverterFactoryFn, c as ShikiTransformerFactoryFn } from '../../../index-B1d5alka.js';
 import 'asciidoctor';
 import 'astro/zod';
 

package/dist/lib/asciidoc/templates/engines/index.cjs

@@ -44,6 +44,8 @@ var AbstractEngine = class {
     this._extensions = _extensions;
     this.templateList = /* @__PURE__ */ new Map();
   }
+  _name;
+  _extensions;
   templateList;
   /**
    * Returns the given name to this template engine.

package/dist/lib/asciidoc/templates/engines/index.d.cts

@@ -1,4 +1,4 @@
-import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-C1F2jTPD.cjs';
+import { A as AbstractEngine, b as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-B1d5alka.cjs';
 import { AbstractBlock } from 'asciidoctor';
 import 'shiki';
 import 'astro/zod';

package/dist/lib/asciidoc/templates/engines/index.d.ts

@@ -1,4 +1,4 @@
-import { b as AbstractEngine, a as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-C1F2jTPD.js';
+import { A as AbstractEngine, b as AsciidocTemplate, T as TemplateModule, F as FilesystemTemplate, R as RawTemplate } from '../../../../index-B1d5alka.js';
 import { AbstractBlock } from 'asciidoctor';
 import 'shiki';
 import 'astro/zod';

package/dist/lib/asciidoc/templates/engines/index.js

@@ -3,7 +3,7 @@ import {
   HandlebarsEngine,
   NunjucksEngine,
   TemplateStr
-} from "../../../../chunk-5LUVP7HW.js";
+} from "../../../../chunk-S7W7VGV4.js";
 export {
   AbstractEngine,
   HandlebarsEngine,

package/dist/lib/shiki/transformers/index.d.cts

@@ -1,16 +1,54 @@
-import { c as ShikiTransformerFactory } from '../../../index-C1F2jTPD.cjs';
+import { S as ShikiTransformerFactory } from '../../../index-B1d5alka.cjs';
 import { BundledLanguage } from 'shiki';
 import 'asciidoctor';
 import 'astro/zod';
 
 type PromptOptions = Partial<{
+    /**
+     * The string prefixed on every line of the code block. It's an empty
+     * string by default.
+     *
+     * @default ''
+     */
     prompt: string;
+    /**
+     * CSS classes to apply to the newly-inserted node containing the
+     * prompt. It's an empty string by default.
+     *
+     * @default ''
+     */
     cssClasses: string;
+    /**
+     * Allows to hide the prompt for the next line, if the current line
+     * ends with the given string. Use this to output, for example, multi
+     * line console commands.
+     *
+     * @default '\\'
+     */
     breakOn: string;
+    /**
+     * If the current line ends with a `breakOn` string sequence, this
+     * option determines whether the newline break should be hidden from
+     * the output or not. For multi-line console commands you may want to
+     * display the "\" delimiter for clarity, but other consoles,
+     * interpreters, or REPLs might look better with this out of the way.
+     *
+     * @default false
+     */
     hideBreak: boolean;
 }>;
 type TransformerOptions$1 = PromptOptions & Partial<{
+    /**
+     * Specify options on a per language basis. These take precedence
+     * over the options applied to all languages. Or, instead of a whole
+     * object, provide a string as a shortcut for the `prompt` option.
+     */
     langs: Partial<Record<BundledLanguage, PromptOptions | string>>;
+    /**
+     * If the source AsciiDoc node being processed includes this custom
+     * attribue, it will be read and used as the `prompt` for this code
+     * block. This takes the most precedence over other prompt options.
+     */
     promptAttribute: string;
 }>;
 declare const transformerPrompt: ShikiTransformerFactory<TransformerOptions$1>;

package/dist/lib/shiki/transformers/index.d.ts

@@ -1,16 +1,54 @@
-import { c as ShikiTransformerFactory } from '../../../index-C1F2jTPD.js';
+import { S as ShikiTransformerFactory } from '../../../index-B1d5alka.js';
 import { BundledLanguage } from 'shiki';
 import 'asciidoctor';
 import 'astro/zod';
 
 type PromptOptions = Partial<{
+    /**
+     * The string prefixed on every line of the code block. It's an empty
+     * string by default.
+     *
+     * @default ''
+     */
     prompt: string;
+    /**
+     * CSS classes to apply to the newly-inserted node containing the
+     * prompt. It's an empty string by default.
+     *
+     * @default ''
+     */
     cssClasses: string;
+    /**
+     * Allows to hide the prompt for the next line, if the current line
+     * ends with the given string. Use this to output, for example, multi
+     * line console commands.
+     *
+     * @default '\\'
+     */
     breakOn: string;
+    /**
+     * If the current line ends with a `breakOn` string sequence, this
+     * option determines whether the newline break should be hidden from
+     * the output or not. For multi-line console commands you may want to
+     * display the "\" delimiter for clarity, but other consoles,
+     * interpreters, or REPLs might look better with this out of the way.
+     *
+     * @default false
+     */
     hideBreak: boolean;
 }>;
 type TransformerOptions$1 = PromptOptions & Partial<{
+    /**
+     * Specify options on a per language basis. These take precedence
+     * over the options applied to all languages. Or, instead of a whole
+     * object, provide a string as a shortcut for the `prompt` option.
+     */
     langs: Partial<Record<BundledLanguage, PromptOptions | string>>;
+    /**
+     * If the source AsciiDoc node being processed includes this custom
+     * attribue, it will be read and used as the `prompt` for this code
+     * block. This takes the most precedence over other prompt options.
+     */
     promptAttribute: string;
 }>;
 declare const transformerPrompt: ShikiTransformerFactory<TransformerOptions$1>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d10f/asciidoc-astro-loader",
-	"version": "0.0.16",
+	"version": "0.2.0",
 	"description": "An Astro collections loader for Asciidoc files",
 	"author": "D10f",
 	"license": "MIT",
@@ -36,7 +36,8 @@
 		"./transformers": "./dist/lib/shiki/transformers/index.js"
 	},
 	"devDependencies": {
-		"astro": "^5.15.3",
+		"@types/node": "^25.9.1",
+		"astro": "^6.3.1",
 		"eslint": "^9.36.0",
 		"eslint-plugin-prettier": "^5.5.4",
 		"globals": "^16.4.0",
@@ -46,14 +47,14 @@
 		"tsup": "^8.5.0",
 		"typescript": "^5.9.3",
 		"typescript-eslint": "^8.45.0",
-		"vitest": "^3.2.4"
+		"vitest": "^5.0.3"
 	},
 	"dependencies": {
-		"@shikijs/transformers": "^3.20.0",
+		"@shikijs/transformers": "^4.5.0",
 		"asciidoctor": "^3.0.4",
-		"shiki": "^3.20.0"
+		"shiki": "^4.5.0"
 	},
 	"peerDependencies": {
-		"astro": "^5.0.0"
+		"astro": "^6.3.1"
 	}
 }