glossary macro

src/plugins/rehype/index.ts

@@ -8,10 +8,10 @@ import { injectHeadingSlugsPlugin } from './inject-heading-slugs.ts';
 import { injectLinkClassesPlugin } from './inject-link-classes.ts';
 
 const rehypePlugins: RehypePlugins = [
-  injectLinkClassesPlugin,
   injectHeadingSlugsPlugin,
   [rehypeAutolinkHeadings, { behavior: 'append' }],
   rehypeRaw,
+  injectLinkClassesPlugin,
   injectDtIdsPlugin,
   checkReferencedAnchorsPlugin,
 ];

src/plugins/remark/macros/macros/glossary.ts

@@ -0,0 +1,37 @@
+import type { Html } from 'mdast';
+import { SKIP } from 'unist-util-visit';
+
+import type { MacroFunction, MacroNode } from '../types.ts';
+import { wrappedStringSchema } from '../validation.ts';
+
+function parseArguments(value: string[]): [string, string | undefined] {
+  if (value.length === 0 || !value[0]) {
+    throw new Error('No arguments provided');
+  }
+  return [
+    wrappedStringSchema.parse(value[0]),
+    value[1] ? wrappedStringSchema.parse(value[1]) : undefined,
+  ];
+}
+
+function macro(node: MacroNode): Html {
+  const targetLocale = process.env.TARGET_LOCALE;
+  let arguments_ = parseArguments(node.parameters);
+  let string_ = arguments_[1] || arguments_[0];
+
+  const basePath = `/${targetLocale}/docs/Glossary/`;
+  const subPath = arguments_[0].replaceAll(/\s+/g, '_');
+
+  return {
+    type: 'html',
+    value: `<a href="${basePath + subPath}">${string_}</a>`,
+  };
+}
+
+const glossary: MacroFunction = (node, index, parent) => {
+  const replacement = macro(node);
+  parent.children[index] = replacement;
+  return [SKIP, index];
+};
+
+export default glossary;

src/plugins/remark/macros/macros/index.ts

@@ -6,6 +6,7 @@ import GlossarySidebar from './GlossarySidebar.ts';
 import HTMLElement from './HTMLElement.ts';
 import cssxref from './cssxref.ts';
 import domxref from './domxref.ts';
+import glossary from './glossary.ts';
 import jsSidebar from './jsSidebar/index.ts';
 import jsxref from './jsxref.ts';
 
@@ -16,6 +17,7 @@ const MACROS: Record<string, MacroFunction> = {
   HTMLElement,
   cssxref,
   domxref,
+  glossary,
   jsSidebar,
   jsxref,
 };