@redpanda-data/docs-extensions-and-macros 3.0.12 → 3.0.13

package/README.adoc

@@ -40,7 +40,7 @@ npm i @redpanda-data/docs-extensions-and-macros
 
 To use the development version instead, refer to the <<development-quickstart,Development Quickstart>>.
 
-== Extensions
+== Antora Extensions
 
 This section documents the Antora extensions that are provided by this library and how to configure them.
 
@@ -170,6 +170,24 @@ antora:
     unlistedPagesHeading: 'Additional Resources'
 ```
 
+== Asciidoc Extensions
+
+This section documents the Asciidoc extensions that are provided by this library and how to configure them.
+
+IMPORTANT: Be sure to register each extension under the `asciidoc.extensions` key in the playbook, not the `antora.extensions` key.
+
+=== Add line numbers and highlights
+
+This extension adds the necessary classes to make line numbers and line highlighting work with Prism.js.
+
+==== Registration example
+
+```yaml
+antora:
+  extensions:
+  - '@redpanda-data/docs-extensions-and-macros/asciidoc-extensions/add-line-numbers-highlights'
+```
+
 == Macros
 
 This section documents the Asciidoc macros that are provided by this library and how to configure them.

package/asciidoc-extensions/add-line-numbers-highlights.js

@@ -0,0 +1,30 @@
+function addLineNumbersAndCodeHighlightingAttributes() {
+  this.process((doc) => {
+    for (const listingBlock of doc.findBy({ context: 'listing' })) {
+      const attributes = listingBlock.getAttributes();
+
+      // Iterate through all attributes of the listing block
+      for (let key in attributes) {
+        if (key.startsWith('lines')) {
+          let newRoleValue = `${key}-${attributes[key]}`;
+
+          if (attributes.role) {
+            if (!attributes.role.includes('line-numbers')) {
+              newRoleValue += ' line-numbers';
+            }
+            listingBlock.setAttribute('role', attributes.role + ' ' + newRoleValue);
+          } else {
+            newRoleValue += ' line-numbers';
+            listingBlock.setAttribute('role', newRoleValue);
+          }
+        }
+      }
+    }
+  });
+}
+
+function register(registry, { file }) {
+  registry.treeProcessor(addLineNumbersAndCodeHighlightingAttributes)
+}
+
+module.exports.register = register;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.0.12",
+  "version": "3.0.13",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -23,6 +23,9 @@
     }
   ],
   "exports": {
+    "./asciidoc-extensions/add-line-numbers-highlights": {
+      "require": "./asciidoc-extensions/add-line-numbers-highlights.js"
+    },
     "./extensions/unlisted-pages": {
       "require": "./extensions/unlisted-pages.js"
     },
@@ -37,6 +40,7 @@
   },
   "files": [
     "extensions",
+    "asciidoc-extensions",
     "macros"
   ],
   "license": "ISC",