feat: issue autolink

dev/app.config.ts

@@ -21,6 +21,7 @@ export default defineConfig(
 				github: "https://github.com/kobaltedev/solidbase",
 				discord: "https://discord.com/invite/solidjs",
 			},
+			issueAutolink: "https://github.com/kobaltedev/solidbase/issues/:issue",
 			search: {
 				provider: "algolia",
 				options: {

dev/src/routes/index.mdx

@@ -60,6 +60,8 @@ www.example.com
 
 [Link internal /about](/about)
 
+#20 also #4 but no \\#20
+
 A note[^1]
 
 [^1]: Big note.

docs/app.config.ts

@@ -21,6 +21,7 @@ export default defineConfig(
 				github: "https://github.com/kobaltedev/solidbase",
 				discord: "https://discord.com/invite/solidjs",
 			},
+			issueAutolink: "https://github.com/kobaltedev/solidbase/issues/:issue",
 			lang: "en",
 			locales: {
 				fr: {

docs/src/routes/guide/dev.mdx

@@ -64,6 +64,8 @@ www.example.com
 
 [Link internal /about](/about)
 
+#20 also #4 but no \\#20
+
 A note[^1]
 
 [^1]: Big note.

package.json

@@ -87,6 +87,7 @@
     "remark-mdx-frontmatter": "^5.0.0",
     "solid-mdx": "^0.0.7",
     "unified": "^11.0.5",
+    "unist-builder": "^4.0.0",
     "unist-util-visit": "^5.0.0"
   }
 }

src/config.ts

@@ -23,6 +23,7 @@ import { rehypeFixExpressiveCodeJsx } from "./rehype-plugins";
 import {
 	remarkCustomContainers,
 	remarkGithubAlertsToDirectives,
+	remarkIssueAutolink,
 	remarkRelativeImports,
 	remarkTOC,
 } from "./remark-plugins";
@@ -58,6 +59,7 @@ export type SolidBaseConfig = {
 	titleTemplate?: string;
 	componentsFolder?: string;
 	editPath?: string | ((path: string) => string);
+	issueAutolink?: false | string | ((issue: string) => string);
 	lastUpdated?: Intl.DateTimeFormatOptions | false;
 	footer?: boolean;
 	socialLinks?:
@@ -75,7 +77,8 @@ type ResolvedConfigKeys =
 	| "description"
 	| "lastUpdated"
 	| "footer"
-	| "lang";
+	| "lang"
+	| "issueAutolink";
 
 export type SolidBaseResolvedConfig = Omit<
 	SolidBaseConfig,
@@ -109,6 +112,7 @@ export function withSolidBase(
 	baseConfig.footer ??= true;
 	baseConfig.lang ??= "en-US";
 	baseConfig.sidebar ??= { items: [] };
+	baseConfig.issueAutolink ??= false;
 
 	process.env.PORT ??= "4000";
 
@@ -167,6 +171,7 @@ export function withSolidBase(
 					remarkRelativeImports,
 					remarkTOC,
 					remarkCustomContainers,
+					[remarkIssueAutolink, baseConfig.issueAutolink],
 				],
 			}),
 		);

src/remark-plugins.ts

@@ -2,7 +2,9 @@ import { fromJs } from "esast-util-from-js";
 import { h } from "hastscript";
 import { findAndReplace } from "mdast-util-find-and-replace";
 import { toc } from "mdast-util-toc";
+import { u } from "unist-builder";
 import { visit } from "unist-util-visit";
+import { SolidBaseConfig, type SolidBaseResolvedConfig } from "./config";
 
 interface ParagraphNode {
 	type: "paragraph";
@@ -82,6 +84,35 @@ export function remarkTOC() {
 	};
 }
 
+export function remarkIssueAutolink(
+	issueAutolink: SolidBaseResolvedConfig["issueAutolink"],
+) {
+	if (issueAutolink === false) return;
+
+	const url = (issue: string) => {
+		const number = issue.slice(1);
+		if (typeof issueAutolink === "function") return issueAutolink(number);
+		return issueAutolink.replace(":issue", number);
+	};
+
+	return (tree: any) => {
+		findAndReplace(tree, [
+			[
+				/(?<=(^| ))#\d+/gm,
+				(match: string) => {
+					return u("link", { url: url(match) }, [u("text", match)]);
+				},
+			],
+			[
+				/\\#\d+/g,
+				(match: string) => {
+					return match.slice(1);
+				},
+			],
+		]);
+	};
+}
+
 const customContainers = new Set([
 	"info",
 	"note",