From f10b1e85f13e5db44a5f17cd9f10218d070f8381 Mon Sep 17 00:00:00 2001
From: Francis Lavoie <lavofr@gmail.com>
Date: Thu, 7 Sep 2023 14:18:30 -0400
Subject: [PATCH] Use window.$ to make VSCode syntax highlighting play nice

---
 src/docs/markdown/caddyfile/directives/encode.md |  2 +-
 .../markdown/caddyfile/directives/file_server.md |  4 ++--
 src/docs/markdown/caddyfile/directives/log.md    |  2 +-
 .../markdown/caddyfile/directives/php_fastcgi.md |  2 +-
 .../caddyfile/directives/reverse_proxy.md        | 10 +++++-----
 src/docs/markdown/caddyfile/directives/tls.md    |  2 +-
 src/docs/markdown/caddyfile/matchers.md          | 10 +++++-----
 src/docs/markdown/caddyfile/options.md           | 16 ++++++++--------
 8 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/src/docs/markdown/caddyfile/directives/encode.md b/src/docs/markdown/caddyfile/directives/encode.md
index 21b3487..dd5a84d 100644
--- a/src/docs/markdown/caddyfile/directives/encode.md
+++ b/src/docs/markdown/caddyfile/directives/encode.md
@@ -3,7 +3,7 @@ title: encode (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links to all the subdirectives if a matching anchor tag is found on the page.
 	addLinksToSubdirectives();
 });
diff --git a/src/docs/markdown/caddyfile/directives/file_server.md b/src/docs/markdown/caddyfile/directives/file_server.md
index cc34ace..bca1c51 100644
--- a/src/docs/markdown/caddyfile/directives/file_server.md
+++ b/src/docs/markdown/caddyfile/directives/file_server.md
@@ -3,9 +3,9 @@ title: file_server (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// Fix inline browse arg
-	$('pre.chroma .s:contains("browse")').first()
+	window.$('pre.chroma .s:contains("browse")').first()
 		.wrapAll('<span class="k">').parent()
 		.html('<a href="#browse" style="color: inherit;" title="browse">browse</a>')
 
diff --git a/src/docs/markdown/caddyfile/directives/log.md b/src/docs/markdown/caddyfile/directives/log.md
index b6dffb2..b420b4b 100644
--- a/src/docs/markdown/caddyfile/directives/log.md
+++ b/src/docs/markdown/caddyfile/directives/log.md
@@ -3,7 +3,7 @@ title: log (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links to all the subdirectives if a matching anchor tag is found on the page.
 	addLinksToSubdirectives();
 });
diff --git a/src/docs/markdown/caddyfile/directives/php_fastcgi.md b/src/docs/markdown/caddyfile/directives/php_fastcgi.md
index 3eee493..7ab7183 100644
--- a/src/docs/markdown/caddyfile/directives/php_fastcgi.md
+++ b/src/docs/markdown/caddyfile/directives/php_fastcgi.md
@@ -3,7 +3,7 @@ title: php_fastcgi (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links to all the subdirectives if a matching anchor tag is found on the page.
 	addLinksToSubdirectives();
 });
diff --git a/src/docs/markdown/caddyfile/directives/reverse_proxy.md b/src/docs/markdown/caddyfile/directives/reverse_proxy.md
index 88ebddf..bb2a1df 100644
--- a/src/docs/markdown/caddyfile/directives/reverse_proxy.md
+++ b/src/docs/markdown/caddyfile/directives/reverse_proxy.md
@@ -3,19 +3,19 @@ title: reverse_proxy (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// Fix response matchers to render with the right color,
 	// and link to response matchers section
-	$('pre.chroma .k:contains("@")')
+	window.$('pre.chroma .k:contains("@")')
 		.map(function(k, item) {
 			let text = item.innerText.replace(/</g,'&lt;').replace(/>/g,'&gt;');
 			let url = '#' + item.innerText.replace(/_/g, "-");
-			$(item).addClass('nd').removeClass('k')
-			$(item).html('<a href="#response-matcher" style="color: inherit;" title="Response matcher">' + text + '</a>');
+			window.$(item).addClass('nd').removeClass('k')
+			window.$(item).html(`<a href="#response-matcher" style="color: inherit;" title="Response matcher">${text}</a>`);
 		});
 
 	// Fix matcher placeholder
-	$('pre.chroma .k:contains("handle_response")').first().nextAll().slice(0, 3)
+	window.$('pre.chroma .k:contains("handle_response")').first().nextAll().slice(0, 3)
 		.wrapAll('<span class="nd">').parent()
 		.html('<a href="#response-matcher" style="color: inherit;" title="Response matcher">[&lt;matcher&gt;]</a>')
 
diff --git a/src/docs/markdown/caddyfile/directives/tls.md b/src/docs/markdown/caddyfile/directives/tls.md
index f784baa..4a1f5be 100644
--- a/src/docs/markdown/caddyfile/directives/tls.md
+++ b/src/docs/markdown/caddyfile/directives/tls.md
@@ -3,7 +3,7 @@ title: tls (Caddyfile directive)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links to all the subdirectives if a matching anchor tag is found on the page.
 	addLinksToSubdirectives();
 });
diff --git a/src/docs/markdown/caddyfile/matchers.md b/src/docs/markdown/caddyfile/matchers.md
index a4301ca..4532298 100644
--- a/src/docs/markdown/caddyfile/matchers.md
+++ b/src/docs/markdown/caddyfile/matchers.md
@@ -3,26 +3,26 @@ title: Request matchers (Caddyfile)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links on the matchers in the code blocks
 	// to their associated anchor tags.
 	let headers = $('article h3').map((i, el) => el.id.replace(/-/g, "_")).toArray();
-	$('pre.chroma .k')
+	window.$('pre.chroma .k')
 		.filter((k, item) => headers.includes(item.innerText))
 		.map(function(k, item) {
 			let text = item.innerText.replace(/</g,'&lt;').replace(/>/g,'&gt;');
 			let url = '#' + item.innerText.replace(/_/g, "-");
-			$(item).html('<a href="' + url + '" style="color: inherit;" title="' + text + '">' + text + '</a>');
+			window.$(item).html(`<a href="${url}" style="color: inherit;" title="${text}">${text}</a>`);
 		});
 
 	// Link matcher tokens based on their contents to the syntax section
-	$('pre.chroma .nd')
+	window.$('pre.chroma .nd')
 		.map(function(k, item) {
 			let text = item.innerText.replace(/</g,'&lt;').replace(/>/g,'&gt;');
 			let anchor = "named-matchers"
 			if (text == "*") anchor = "wildcard-matchers"
 			if (text.startsWith('/')) anchor = "path-matchers"
-			$(item).html('<a href="#' + anchor + '" style="color: inherit;" title="Matcher token">' + text + '</a>');
+			window.$(item).html(`<a href="#${anchor}" style="color: inherit;" title="Matcher token">${text}</a>`);
 		});
 });
 </script>
diff --git a/src/docs/markdown/caddyfile/options.md b/src/docs/markdown/caddyfile/options.md
index 65b557f..3b0a36a 100644
--- a/src/docs/markdown/caddyfile/options.md
+++ b/src/docs/markdown/caddyfile/options.md
@@ -3,30 +3,30 @@ title: Global options (Caddyfile)
 ---
 
 <script>
-$(function() {
+window.$(function() {
 	// We'll add links on the options in the code block at the top
 	// to their associated anchor tags.
 	let headers = $('article h5').map((i, el) => el.id.replace(/-/g, "_")).toArray();
-	$('pre.chroma .k')
+	window.$('pre.chroma .k')
 		.filter((k, item) => headers.includes(item.innerText))
 		.map(function(k, item) {
 			let text = item.innerText.replace(/</g,'&lt;').replace(/>/g,'&gt;');
 			let url = '#' + item.innerText.replace(/_/g, "-");
-			$(item).html('<a href="' + url + '" style="color: inherit;" title="' + text + '">' + text + '</a>');
+			window.$(item).html(`<a href="${url}" style="color: inherit;" title="${text}">${text}</a>`);
 		});
 	// Add links on comments to their respective sections
-	$('pre.chroma .c1')
+	window.$('pre.chroma .c1')
 		.filter((k, item) => item.innerText.includes('#'))
 		.map(function(k, item) {
 			let text = item.innerText;
-			let before = text.slice(0, text.indexOf('#'));
-			text = text.slice(text.indexOf('#'));
+			let before = text.slice(0, text.indexOf('#')); // the leading whitespace
+			text = text.slice(text.indexOf('#')); // only the comment part
 			let url = '#' + text.replace(/#/g, '').trim().toLowerCase().replace(/ /g, "-");
-			$(item).html(before + '<a href="' + url + '" style="color: inherit;" title="' + text + '">' + text + '</a>');
+			window.$(item).html(`${before}<a href="${url}" style="color: inherit;" title="${text}">${text}</a>`);
 		});
 	// Surgically fix a duplicate link; 'name' appears twice as a link
 	// for two different sections, so we change the second to #name-1
-	$('pre.chroma .line:contains("ca [<id>]")')
+	window.$('pre.chroma .line:contains("ca [<id>]")')
 		.next()
 		.find('a:contains("name")')
 		.attr('href', '#name-1');