@d10f/asciidoc-astro-loader 0.1.0 → 0.2.0

package/README.md

@@ -353,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(),
@@ -373,6 +382,9 @@ const blog = defineCollection({
 				transformerPrompt({
 					langs: {
 						console: '$',
+						prolog: {
+							hideBreak: true,
+						},
 					},
 					cssClasses: 'unselectable mr-2 opacity-50',
 				}),
@@ -382,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d10f/asciidoc-astro-loader",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"description": "An Astro collections loader for Asciidoc files",
 	"author": "D10f",
 	"license": "MIT",
@@ -47,12 +47,12 @@
 		"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": "^6.3.1"