do11y 0.5.12 → 0.5.14

package/dist/docs/cli.js

@@ -5,7 +5,7 @@ if (command !== "dev" && command !== "build" && command !== "preview") {
     throw new Error();
 }
 const userViteConfig = await getUserViteConfig(command);
-const mergedViteConfig = mergeConfig(userViteConfig, viteConfig);
+const mergedViteConfig = mergeConfig(userViteConfig, viteConfig(userViteConfig.base));
 if (command === "dev") {
     const server = await createServer(mergedViteConfig);
     await server.listen();

package/dist/docs/html/plugin.d.ts

@@ -1,2 +1,2 @@
 import type { Plugin } from "vite";
-export declare const indexHtml: (folder: string, key: "index" | "sandbox") => Omit<Plugin, "name">;
+export declare const indexHtml: (folder: string, key: "index" | "sandbox", base?: string) => Omit<Plugin, "name">;

package/dist/docs/html/plugin.js

@@ -2,8 +2,7 @@ import { join } from "node:path";
 import { writeFileSync } from "node:fs";
 import { output } from "../files.js";
 import { render } from "./render.js";
-import { getUserViteConfig } from "../vite-config.js";
-export const indexHtml = (folder, key) => ({
+export const indexHtml = (folder, key, base) => ({
     async writeBundle(_, bundle) {
         const chunk = Object.values(bundle).find((chunk) => {
             return chunk.type === "chunk" && chunk.isEntry && chunk.facadeModuleId?.endsWith(`${key}.js`);
@@ -12,7 +11,6 @@ export const indexHtml = (folder, key) => ({
             throw new Error(`Failed to create HTML file for ${key}.`);
         }
         const stylesheets = Array.from(chunk.viteMetadata?.importedCss || []);
-        const { base } = await getUserViteConfig("build");
         const html = render(base, chunk.fileName, stylesheets);
         writeFileSync(join(output, `${key}.html`), html);
         if (key === "index") {
@@ -26,7 +24,6 @@ export const indexHtml = (folder, key) => ({
             if (!req.url || req.method !== "GET" || !req.headers.accept?.includes("text/html")) {
                 return next();
             }
-            const { base } = await getUserViteConfig("build");
             const html = render(base, `/@fs/${req.url?.startsWith("/sandbox") ? sandboxBundle : bundle}`);
             const transformedHtml = await server.transformIndexHtml(req.url, html);
             res.statusCode = 200;

package/dist/docs/html/render.js

@@ -7,7 +7,7 @@ export const render = (base = "", script, stylesheets = []) => {
     const faviconElement = jsdom.window.document.createElement("link");
     faviconElement.setAttribute("rel", "icon");
     faviconElement.setAttribute("href", `${base}favicon.ico`);
-    jsdom.window.document.documentElement.appendChild(faviconElement);
+    jsdom.window.document.head.appendChild(faviconElement);
     const scriptElement = jsdom.window.document.createElement("script");
     scriptElement.setAttribute("type", "module");
     scriptElement.setAttribute("src", `${base}${script}`);

package/dist/docs/plugins/meta/meta.d.ts

@@ -3,5 +3,5 @@ import type { Plugin } from "vite";
  * Adds `.vue?meta` imports which returns a simplified result
  * of running the component through `vue-component-meta`.
  */
-declare const _default: () => Plugin;
+declare const _default: (base?: string) => Plugin;
 export default _default;

package/dist/docs/plugins/meta/meta.js

@@ -4,8 +4,21 @@ import { createChecker } from "vue-component-meta";
 import { parse as parseVue } from "vue/compiler-sfc";
 import { parse as parseDocs } from "vue-docgen-api";
 import markdown from "markdown-it";
+import replaceLinkPlugin from "markdown-it-replace-link";
 import { root } from "../../files.js";
 import { mapMeta } from "./meta-mapper.js";
+const getLinkType = (url) => {
+    if (url.startsWith("#")) {
+        return "anchor";
+    }
+    if (URL.canParse(url)) {
+        return "absolute";
+    }
+    if (URL.canParse(url, "https://github.com/sq11y/do11y")) {
+        return "relative";
+    }
+    return "invalid";
+};
 const getFirstExistingFile = (...paths) => {
     for (const path of paths) {
         if (existsSync(path)) {
@@ -17,7 +30,7 @@ const getFirstExistingFile = (...paths) => {
  * Adds `.vue?meta` imports which returns a simplified result
  * of running the component through `vue-component-meta`.
  */
-export default () => {
+export default (base) => {
     const tsconfig = getFirstExistingFile(join(root, "tsconfig.app.json"), join(root, "tsconfig.json"));
     if (!tsconfig) {
         return {
@@ -30,6 +43,15 @@ export default () => {
     const md = markdown({
         html: true,
     });
+    if (base) {
+        md.use(replaceLinkPlugin, {
+            processHTML: true,
+            replaceLink: (link) => {
+                const url = base.startsWith("/") ? link.replace(/^\//, "") : link;
+                return ["anchor", "relative"].includes(getLinkType(link)) ? `${base}${url}` : link;
+            },
+        });
+    }
     return {
         name: "do11y:meta",
         async transform(_, id) {

package/dist/docs/plugins/plugins.d.ts

@@ -1,2 +1,2 @@
 import type { Plugin } from "vite";
-export declare const plugins: () => Plugin[];
+export declare const plugins: (base?: string) => Plugin[];

package/dist/docs/plugins/plugins.js

@@ -8,12 +8,12 @@ import block from "v-custom-block";
 import options from "./options.js";
 import routes from "./routes.js";
 import { do11yOptions } from "../options.js";
-export const plugins = () => [
-    ui(),
-    sandbox(),
+export const plugins = (base) => [
+    ui(base),
+    sandbox(base),
     highlightCss(),
     highlight(),
-    meta(),
+    meta(base),
     markdown(do11yOptions),
     block("docs"),
     options(),

package/dist/docs/plugins/sandbox.d.ts

@@ -4,5 +4,5 @@ export declare const toParamId: (path: string) => string;
  * Creates a seprate sandbox app, and
  * adds access to sandbox components through `do11y:sandboxes`.
  */
-declare const _default: () => Plugin;
+declare const _default: (base?: string) => Plugin;
 export default _default;

package/dist/docs/plugins/sandbox.js

@@ -7,7 +7,7 @@ export const toParamId = (path) => parse(path).name.toLowerCase().replace(".sand
  * Creates a seprate sandbox app, and
  * adds access to sandbox components through `do11y:sandboxes`.
  */
-export default () => {
+export default (base) => {
     const moduleId = "do11y:sandboxes";
     const resolvedModuleId = "\0" + moduleId;
     const sandboxFiles = globSync(["(docs|src|packages)/**/*.sandbox.vue"], {
@@ -18,7 +18,7 @@ export default () => {
     });
     return {
         name: "do11y:sandboxes",
-        ...indexHtml(ui, "sandbox"),
+        ...indexHtml(ui, "sandbox", base),
         resolveId(id) {
             if (id === moduleId) {
                 return resolvedModuleId;

package/dist/docs/plugins/ui.d.ts

@@ -2,5 +2,5 @@ import type { Plugin } from "vite";
 /**
  * The main documentation app.
  */
-declare const _default: () => Plugin;
+declare const _default: (base?: string) => Plugin;
 export default _default;

package/dist/docs/plugins/ui.js

@@ -3,4 +3,4 @@ import { indexHtml } from "../html/plugin.js";
 /**
  * The main documentation app.
  */
-export default () => ({ name: "do11y:ui", ...indexHtml(ui, "index") });
+export default (base) => ({ name: "do11y:ui", ...indexHtml(ui, "index", base) });

package/dist/docs/vite-config.d.ts

@@ -6,7 +6,7 @@ export declare const getUserViteConfig: (command: "dev" | "build" | "preview") =
         alias?: import("vite").AliasOptions;
     }) | undefined;
 }>;
-export declare const viteConfig: {
+export declare const viteConfig: (base?: string) => {
     root: string;
     plugins: Plugin<any>[];
     server: {

package/dist/docs/vite-config.js

@@ -59,9 +59,9 @@ const getUserPlugins = async (userViteConfig) => {
         ...resolvedUserPlugins.filter((i) => i.name !== "vite:vue"),
     ];
 };
-export const viteConfig = {
+export const viteConfig = (base) => ({
     root: docs,
-    plugins: plugins(),
+    plugins: plugins(base),
     server: {
         port: 1998,
         fs: {
@@ -84,4 +84,4 @@ export const viteConfig = {
             },
         },
     },
-};
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "do11y",
-  "version": "0.5.12",
+  "version": "0.5.14",
   "description": "A bare-bones tool to document Vue components.",
   "keywords": [
     "docs-generator",
@@ -34,6 +34,7 @@
     "jsdom": "^29.1.1",
     "markdown-it": "^14.1.1",
     "markdown-it-attrs": "^4.3.1",
+    "markdown-it-replace-link": "^1.2.2",
     "shiki": "^4.0.2",
     "tinyglobby": "^0.2.16",
     "v-custom-block": "^1.0.67",