add custom plugins for prism

Author: CodeShellDev

docusaurus.config.js

@@ -67,11 +67,11 @@ const config = {
 				theme: {
 					customCss: ["./src/css/custom.css"],
 				},
-        		sitemap: {
-          			lastmod: 'date',
-          			changefreq: 'weekly',
-          			priority: 0.5,
-          			filename: 'sitemap.xml',
+				sitemap: {
+					lastmod: "date",
+					changefreq: "weekly",
+					priority: 0.5,
+					filename: "sitemap.xml",
 				},
 			}),
 		],
@@ -141,14 +141,23 @@ const config = {
 			prism: {
 				theme: prismThemes.github,
 				darkTheme: prismThemes.oneDark,
-				additionalLanguages: ["bash", "apacheconf"],
-				plugins: ["line-numbers", "command-line"],
+				additionalLanguages: [
+					"bash",
+					"apacheconf",
+					"custom-yaml-scalar",
+					"custom-go-template",
+					"custom-yaml-go-template",
+					"custom-yaml-empty-key",
+				],
 			},
 			metadata: [
-    			{ name: "google-site-verification", content: "g8d_0UGQgwAYseQGOOqRvsTPup3xawCbb-i2jT9HyVc" },
+				{
+					name: "google-site-verification",
+					content: "g8d_0UGQgwAYseQGOOqRvsTPup3xawCbb-i2jT9HyVc",
+				},
 				{ name: "og:site_name", content: "Secured Signal API" },
-  			]
-	}),
+			],
+		}),
 }
 
 export default config

src/theme/prism-include-languages.js

@@ -0,0 +1,30 @@
+import siteConfig from "@generated/docusaurus.config"
+export default function prismIncludeLanguages(PrismObject) {
+	const {
+		themeConfig: { prism },
+	} = siteConfig
+	const { additionalLanguages } = prism
+	// Prism components work on the Prism instance on the window, while prism-
+	// react-renderer uses its own Prism instance. We temporarily mount the
+	// instance onto window, import components to enhance it, then remove it to
+	// avoid polluting global namespace.
+	// You can mutate PrismObject: registering plugins, deleting languages... As
+	// long as you don't re-assign it
+	const PrismBefore = globalThis.Prism
+	globalThis.Prism = PrismObject
+	additionalLanguages.forEach((lang) => {
+		if (lang.startsWith("custom-")) {
+			const customLang = lang.slice("custom-".length)
+
+			require(`./prism/custom/prism-${customLang}`)
+		} else {
+			require(`prismjs/components/prism-${lang}`)
+		}
+	})
+
+	// Clean up and eventually restore former globalThis.Prism object (if any)
+	delete globalThis.Prism
+	if (typeof PrismBefore !== "undefined") {
+		globalThis.Prism = PrismObject
+	}
+}

src/theme/prism/custom/prism-go-template.js

@@ -0,0 +1,39 @@
+const lang = "go-template"
+
+;(function (Prism) {
+	Prism.languages[lang] = {
+		// Go template comments {{/* ... */}}
+		"go-template-comment": {
+			pattern: /\{\{\/\*[\s\S]*?\*\/\}\}/,
+			greedy: true,
+			alias: "comment",
+			inside: {
+				delimiter: /^\{\{\/\*|\*\/\}\}/,
+				content: /[\s\S]+/, // the inner comment content
+			},
+		},
+
+		// Regular Go template expressions {{ ... }}
+		"go-template-variable": {
+			pattern: /\{\{(?!\/\*)[\s\S]+?\}\}/,
+			greedy: true,
+			alias: "variable",
+			inside: {
+				delimiter: /^\{\{|\}\}$/,
+				expression: /[\s\S]+/, // the inner expression
+			},
+		},
+	}
+})(Prism)
+
+export function implement(Prism, object) {
+	if (!object) return
+
+	const base = Prism.languages[lang]
+
+	object.inside = object.inside || {}
+
+	Object.keys(base).forEach((attribute) => {
+		object.inside[attribute] = base[attribute]
+	})
+}

src/theme/prism/custom/prism-yaml-empty-key.js

@@ -0,0 +1,46 @@
+;(function (Prism) {
+	// https://yaml.org/spec/1.2/spec.html#c-ns-anchor-property
+	// https://yaml.org/spec/1.2/spec.html#c-ns-alias-node
+	var anchorOrAlias = /[*&][^\s[\]{},]+/
+	// https://yaml.org/spec/1.2/spec.html#c-ns-tag-property
+	var tag =
+		/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/
+	// https://yaml.org/spec/1.2/spec.html#c-ns-properties(n,c)
+	var properties =
+		"(?:" +
+		tag.source +
+		"(?:[ \t]+" +
+		anchorOrAlias.source +
+		")?|" +
+		anchorOrAlias.source +
+		"(?:[ \t]+" +
+		tag.source +
+		")?)"
+	// https://yaml.org/spec/1.2/spec.html#ns-plain(n,c)
+	// This is a simplified version that doesn't support "#" and multiline keys
+	// All these long scarry character classes are simplified versions of YAML's characters
+	var plainKey =
+		/(?:[^\s\x00-\x08\x0e-\x1f!"#%&'*,\-:>?@[\]`{|}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]|[?:-]<PLAIN>)(?:[ \t]*(?:(?![#:])<PLAIN>|:<PLAIN>))*/.source.replace(
+			/<PLAIN>/g,
+			function () {
+				return /[^\s\x00-\x08\x0e-\x1f,[\]{}\x7f-\x84\x86-\x9f\ud800-\udfff\ufffe\uffff]/
+					.source
+			}
+		)
+	var string = /"(?:[^"\\\r\n]|\\.)*"|'(?:[^'\\\r\n]|\\.)*'/.source
+
+	globalThis.Prism.languages.yaml["key"] = {
+		pattern: RegExp(
+			/((?:^|[:\-,[{\r\n?])[ \t]*(?:<<prop>>[ \t]+)?)<<key>>(?=\s*:(?:\s*|$))/.source
+				.replace(/<<prop>>/g, function () {
+					return properties
+				})
+				.replace(/<<key>>/g, function () {
+					return "(?:" + plainKey + "|" + string + ")"
+				})
+		),
+		greedy: true,
+		lookbehind: true,
+		alias: "atrule",
+	}
+})(Prism)

src/theme/prism/custom/prism-yaml-go-template.js

@@ -0,0 +1,8 @@
+import { implement } from "./prism-go-template"
+;(function (Prism) {
+	const yaml = Prism.languages.yaml
+	if (!yaml) return
+
+	implement(Prism, yaml.scalar)
+	implement(Prism, yaml.string)
+})(Prism)

src/theme/prism/custom/prism-yaml-scalar.js

@@ -0,0 +1,32 @@
+;(function (Prism) {
+	// https://yaml.org/spec/1.2/spec.html#c-ns-anchor-property
+	// https://yaml.org/spec/1.2/spec.html#c-ns-alias-node
+	var anchorOrAlias = /[*&][^\s[\]{},]+/
+	// https://yaml.org/spec/1.2/spec.html#c-ns-tag-property
+	var tag =
+		/!(?:<[\w\-%#;/?:@&=+$,.!~*'()[\]]+>|(?:[a-zA-Z\d-]*!)?[\w\-%#;/?:@&=+$.~*'()]+)?/
+	// https://yaml.org/spec/1.2/spec.html#c-ns-properties(n,c)
+	var properties =
+		"(?:" +
+		tag.source +
+		"(?:[ \t]+" +
+		anchorOrAlias.source +
+		")?|" +
+		anchorOrAlias.source +
+		"(?:[ \t]+" +
+		tag.source +
+		")?)"
+
+	globalThis.Prism.languages.yaml["scalar"] = {
+		pattern: RegExp(
+			/([\-:]\s*(?:\s<<prop>>[ \t]+)?[|>])[ \t]*([\s\S]*?)(?=(\r?\n[\S\-]|$))/.source.replace(
+				/<<prop>>/g,
+				function () {
+					return properties
+				}
+			)
+		),
+		lookbehind: true,
+		alias: "string",
+	}
+})(Prism)