do11y 0.2.14 → 0.2.15

package/dist/docs/plugins/highlight/highlight.js

@@ -21,7 +21,7 @@ export const highlightCode = (code, lang) => {
             transformerNotationErrorLevel(),
             ...do11yOptions.highlighter.transformers,
             {
-                name: "do11y",
+                name: "do11y:postprocess",
                 postprocess(html) {
                     if (do11yOptions.highlighter.postprocess) {
                         const jsdom = new JSDOM(html);
@@ -32,7 +32,7 @@ export const highlightCode = (code, lang) => {
                 },
             },
             {
-                name: "remove-unwanted-comments",
+                name: "do11y:remove-unwanted-comments",
                 tokens(tokens) {
                     const filter = do11yOptions.highlighter.removeComments;
                     if (filter === false) {

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

@@ -6,6 +6,11 @@ export interface MarkdownPluginOptions {
      * Additional markdown-it setup.
      */
     markdownSetup?: PluginSimple;
+    /**
+     * The callback function for rendering code blocks.
+     * Will default return the highlighted code generated by Shiki directly.
+     */
+    renderCodeBlock?: (highlightedCode: string) => string;
 }
 export interface MarkdownItEnv {
     /**

package/dist/docs/plugins/markdown.js

@@ -13,7 +13,8 @@ export default (options) => {
     const md = markdown({
         html: true,
         highlight(code, lang) {
-            return highlightCode(code, lang);
+            const highlightedCode = highlightCode(code, lang);
+            return options?.renderCodeBlock ? options.renderCodeBlock(highlightedCode) : highlightedCode;
         },
     });
     md.use(frontmatterPlugin);

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

@@ -26,7 +26,9 @@ export default () => {
     const checker = createChecker(tsconfig, {
         noDeclarations: true,
     });
-    const md = markdown();
+    const md = markdown({
+        html: true,
+    });
     return {
         name: "do11y:meta",
         transform(_, id) {

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

@@ -1,6 +1,6 @@
 import type { Plugin } from "vite";
 import type { App, Component } from "vue";
-import type { Router } from "vue-router";
+import type { Router, RouteRecordRaw } from "vue-router";
 import type { BundledTheme, ShikiTransformer, StringLiteralUnion, ThemeInput } from "shiki";
 import type { MarkdownPluginOptions } from "./markdown.js";
 export interface Options extends MarkdownPluginOptions {
@@ -28,6 +28,14 @@ export interface Options extends MarkdownPluginOptions {
      * Custom wrapper component for `.vue.sandbox` imports.
      */
     SandboxIframe?: () => Promise<Component>;
+    /**
+     * Custom additional routes.
+     */
+    routes?: (RouteRecordRaw & {
+        meta: {
+            title: string;
+        };
+    })[];
     /**
      * The code highlighter.
      *   - Markdown code blocks

package/dist/docs/plugins/routes.js

@@ -42,13 +42,25 @@ export default () => {
                 return `
           import options from 'do11y:options';
 
+          import { RouterView } from 'vue-router';
+
           const home = {
             path: "/",
             meta: ${JSON.stringify(homeMeta)},
             component: options.Home
           };
 
-          export default [home, ${stringifiedRoutes.join(",\n")}];
+          const customRoutes = (options.routes ?? []).map(page => ({
+            ...page,
+
+            meta: {
+              slug: page.path,
+
+              ...page.meta,
+            }
+          }))
+ 
+          export default [home, ...customRoutes, ${stringifiedRoutes.join(",\n")}];
         `;
             }
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "do11y",
-  "version": "0.2.14",
+  "version": "0.2.15",
   "description": "A bare-bones tool to document Vue components.",
   "keywords": [
     "docs-generator",