@md-plugins/vite-md-plugin 0.1.0-alpha.1 → 0.1.0-alpha.11

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024-present, Jeff Galbraith
+Copyright (c) 2024-present, MD-PLUGINS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -47,16 +47,16 @@ pnpm add @md-plugins/vite-md-plugin
 To use the `viteMdPlugin`, configure it in your Vite project:
 
 ```js
-import { defineConfig } from 'vite';
-import vue from '@vitejs/plugin-vue';
-import { viteMdPlugin } from 'vite-md-plugin';
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { viteMdPlugin } from 'vite-md-plugin'
 
-const menu = []; // Define your navigation menu structure here
-const basePath = '/docs'; // Base path prefix
+const menu = [] // Define your navigation menu structure here
+const basePath = '/docs' // Base path prefix
 
 export default defineConfig({
-  plugins: [vue(), viteMdPlugin(basePath, menu)],
-});
+  plugins: [vue(), viteMdPlugin({ path: basePath, menu })],
+})
 ```
 
 ## Quasar Framework Configuration
@@ -67,7 +67,7 @@ If you’re using the Quasar Framework, additional configuration is needed to en
 
 ```js
 import { viteMdPlugin } from '@md-plugins/vite-md-plugin';
-import { menu } from './src/assets/menu'; // be sure to create this file
+import { menu } from './src/.q-press/assets/menu'; // be sure to create this file
 
 export default defineConfig((ctx) => {
   // ...
@@ -82,7 +82,13 @@ build: {
   },
 
   vitePlugins: [
-    viteMdPlugin(ctx.appPaths.srcDir + '/pages', menu),
+      [
+        viteMdPlugin,
+        {
+          path: ctx.appPaths.srcDir + '/markdown',
+          menu: sidebar as MenuItem[],
+        },
+      ],
     // ...
   ],
 },
@@ -102,7 +108,7 @@ The `viteMdPlugin` allows you to define a navigation structure that can be updat
 const menu = [
   { title: 'Home', path: '/home' },
   { title: 'About', path: '/about' },
-];
+]
 ```
 
 This menu is passed as a parameter to the plugin and can be used to build a dynamic sidebar or navigation bar in your application.
@@ -122,16 +128,16 @@ The `menu` parameter should conform to the following structure:
 
 ```ts
 export interface MenuItem {
-  name: string;
-  path?: string;
-  icon?: string;
-  iconColor?: string;
-  rightIcon?: string;
-  rightIconColor?: string;
-  badge?: string;
-  children?: MenuItem[];
-  external?: boolean;
-  expanded?: boolean;
+  name: string
+  path?: string
+  icon?: string
+  iconColor?: string
+  rightIcon?: string
+  rightIconColor?: string
+  badge?: string
+  children?: MenuItem[]
+  external?: boolean
+  expanded?: boolean
 }
 ```
 
@@ -143,6 +149,10 @@ To run the tests for this plugin, use the following command:
 pnpm test
 ```
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/vite-plugins/vitemdplugin/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { Plugin } from 'vite';
+
 interface MenuItem {
     name: string;
     path?: string;
@@ -6,7 +8,7 @@ interface MenuItem {
     rightIcon?: string;
     rightIconColor?: string;
     badge?: string;
-    children?: MenuItem[];
+    children?: MenuItem[] | undefined;
     external?: boolean;
     expanded?: boolean;
 }
@@ -32,31 +34,20 @@ interface RelatedItem {
     category: string;
     path: string;
 }
+interface UserConfig {
+    path: string;
+    menu: MenuItem[];
+}
 
 /**
- * Transforms markdown content into Vue Single File Component (SFC) format.
+ * Creates a Vite plugin for processing Markdown files based on the provided user configuration.
+ * This function configures and returns a plugin that transforms Markdown content into Vue Single File Components (SFCs).
  *
- * @param code - The markdown content to be transformed.
- * @param id - The identifier (typically the file path) of the markdown file.
- * @returns The transformed Vue SFC content, or null if the file is not a markdown file.
- * @throws Will throw an error if the markdown transformation process fails.
+ * @param userConfig - The configuration object for the Vite Markdown plugin.
+ * @param userConfig.path - The base path prefix to be used for routing or file resolution.
+ * @param userConfig.menu - An array of MenuItem objects representing the navigation menu structure.
+ * @returns A Vite Plugin object pre-configured with the provided settings for Markdown processing.
  */
-declare function transform(code: string, id: string): {
-    code: string;
-    map: null;
-} | null;
-/**
- * Creates a Vite plugin for processing Markdown files.
- * This plugin transforms Markdown content into Vue Single File Components (SFCs).
- *
- * @param path - The base path prefix to be used for routing or file resolution.
- * @param menu - An array of MenuItem objects representing the navigation menu structure.
- * @returns A Vite plugin object with pre-configured settings for Markdown processing.
- */
-declare function viteMdPlugin(path: string, menu: MenuItem[]): {
-    name: string;
-    enforce: string;
-    transform: typeof transform;
-};
+declare function viteMdPlugin(userConfig: UserConfig): Plugin;
 
-export { type FlatMenu, type FlatMenuEntry, type MenuItem, type MenuNode, type NavItem, type RelatedItem, viteMdPlugin };
+export { type FlatMenu, type FlatMenuEntry, type MenuItem, type MenuNode, type NavItem, type RelatedItem, type UserConfig, viteMdPlugin };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { Plugin } from 'vite';
+
 interface MenuItem {
     name: string;
     path?: string;
@@ -6,7 +8,7 @@ interface MenuItem {
     rightIcon?: string;
     rightIconColor?: string;
     badge?: string;
-    children?: MenuItem[];
+    children?: MenuItem[] | undefined;
     external?: boolean;
     expanded?: boolean;
 }
@@ -32,31 +34,20 @@ interface RelatedItem {
     category: string;
     path: string;
 }
+interface UserConfig {
+    path: string;
+    menu: MenuItem[];
+}
 
 /**
- * Transforms markdown content into Vue Single File Component (SFC) format.
+ * Creates a Vite plugin for processing Markdown files based on the provided user configuration.
+ * This function configures and returns a plugin that transforms Markdown content into Vue Single File Components (SFCs).
  *
- * @param code - The markdown content to be transformed.
- * @param id - The identifier (typically the file path) of the markdown file.
- * @returns The transformed Vue SFC content, or null if the file is not a markdown file.
- * @throws Will throw an error if the markdown transformation process fails.
+ * @param userConfig - The configuration object for the Vite Markdown plugin.
+ * @param userConfig.path - The base path prefix to be used for routing or file resolution.
+ * @param userConfig.menu - An array of MenuItem objects representing the navigation menu structure.
+ * @returns A Vite Plugin object pre-configured with the provided settings for Markdown processing.
  */
-declare function transform(code: string, id: string): {
-    code: string;
-    map: null;
-} | null;
-/**
- * Creates a Vite plugin for processing Markdown files.
- * This plugin transforms Markdown content into Vue Single File Components (SFCs).
- *
- * @param path - The base path prefix to be used for routing or file resolution.
- * @param menu - An array of MenuItem objects representing the navigation menu structure.
- * @returns A Vite plugin object with pre-configured settings for Markdown processing.
- */
-declare function viteMdPlugin(path: string, menu: MenuItem[]): {
-    name: string;
-    enforce: string;
-    transform: typeof transform;
-};
+declare function viteMdPlugin(userConfig: UserConfig): Plugin;
 
-export { type FlatMenu, type FlatMenuEntry, type MenuItem, type MenuNode, type NavItem, type RelatedItem, viteMdPlugin };
+export { type FlatMenu, type FlatMenuEntry, type MenuItem, type MenuNode, type NavItem, type RelatedItem, type UserConfig, viteMdPlugin };

package/dist/index.mjs

@@ -55,7 +55,7 @@ function createMarkdownRenderer(options = {}) {
   md2.use(containersPlugin, containers, createContainer);
   md2.use(blockquotePlugin, { blockquoteClass: "markdown-note" });
   md2.use(tablePlugin, {
-    tableClass: "markdown-page-table",
+    tableClass: "markdown-table",
     tableHeaderClass: "text-left",
     tableToken: "q-markup-table",
     tableAttributes: [
@@ -68,8 +68,8 @@ function createMarkdownRenderer(options = {}) {
     containerComponent: "MarkdownPrerender",
     copyButtonComponent: "MarkdownCopyButton",
     pageScripts: [
-      "import MarkdownPrerender from 'components/md/MarkdownPrerender'",
-      "import MarkdownCopyButton from 'components/md/MarkdownCopyButton.vue'"
+      "import MarkdownPrerender from 'src/.q-press/components/MarkdownPrerender'",
+      "import MarkdownCopyButton from 'src/.q-press/components/MarkdownCopyButton.vue'"
     ]
   });
   md2.use(linkPlugin);
@@ -209,23 +209,18 @@ function getVueComponent(rendered, code, id, prefix, menu) {
   }
   const frontmatter = rendered?.frontmatter || {};
   if (frontmatter.editLink !== false) {
-    frontmatter.editLink = id.substring(
-      id.indexOf("src/pages/") + 10,
-      id.length - 3
-    );
+    frontmatter.editLink = id.substring(id.indexOf("src/markdown/") + 13, id.length - 3);
   }
   const title = frontmatter.title || rendered.env.title || rendered.title || "Generic Page";
   const desc = frontmatter.desc || false;
+  const fullscreen = frontmatter.fullscreen || false;
   const overline = frontmatter.overline || false;
-  const heading = rendered.env.heading || !!title || false;
-  const related = frontmatter.related && Array.isArray(frontmatter.related) && frontmatter.related.map(
-    (entry) => convertToRelated(prefix, flatMenu, entry, id)
-  ) || false;
+  const heading = rendered.env.heading || false;
+  const related = frontmatter.related && Array.isArray(frontmatter.related) && frontmatter.related.map((entry) => convertToRelated(prefix, flatMenu, entry, id)) || false;
   const nav = frontmatter.nav || false;
   const badge = frontmatter.badge || false;
   const toc = rendered.env.toc || false;
   const editLink = frontmatter.editLink || false;
-  frontmatter.components || false;
   const scope = frontmatter.scope || false;
   const examples = frontmatter.examples || false;
   const { mdContent, userScripts } = splitRenderedContent(rendered.html);
@@ -237,6 +232,7 @@ function getVueComponent(rendered, code, id, prefix, menu) {
   <markdown-page
     title="${title}"
     ${desc !== false ? `desc="${desc}"` : ""}
+    ${fullscreen !== false ? "fullscreen" : ""}
     ${overline !== false ? `overline="${overline}"` : ""}
     ${badge !== false ? `badge="${badge}"` : ""}
     ${heading !== false ? "heading" : ""}
@@ -246,7 +242,7 @@ function getVueComponent(rendered, code, id, prefix, menu) {
     ${nav !== false ? ':nav="nav"' : ""}>${mdContent}</markdown-page>
 </template>
 <script setup>
-import { copyHeading } from 'components/md/markdown-utils'
+import { copyHeading } from 'src/.q-press/components/markdown-utils'
 ${examples !== false ? `
 import { provide } from 'vue'
 provide('_markdown_examples_', process.env.CLIENT
@@ -272,34 +268,26 @@ function mdParse(code, id, prefix, menu) {
     },
     pageScripts: /* @__PURE__ */ new Set()
   };
-  env.pageScripts.add(
-    "import MarkdownPage from 'src/layouts/MarkdownPage.vue'"
-  );
+  env.pageScripts.add("import MarkdownPage from 'src/.q-press/layouts/MarkdownPage.vue'");
   if (markdownApiRE.test(code) === true) {
-    env.pageScripts.add(
-      "import MarkdownApi from 'components/md/MarkdownApi.vue'"
-    );
+    env.pageScripts.add("import MarkdownApi from 'src/.q-press/components/MarkdownApi.vue'");
   }
   if (markdownInstallationRE.test(code) === true) {
     env.pageScripts.add(
-      "import MarkdownInstallation from 'components/md/MarkdownInstallation.vue'"
+      "import MarkdownInstallation from 'src/.q-press/components/MarkdownInstallation.vue'"
     );
   }
   if (markdownTreeRE.test(code) === true) {
-    env.pageScripts.add(
-      "import MarkdownTree from 'components/md/MarkdownTree.vue'"
-    );
+    env.pageScripts.add("import MarkdownTree from 'src/.q-press/components/MarkdownTree.vue'");
   }
   const results = md.render(code, env);
   if (env.frontmatter.examples !== void 0) {
     env.pageScripts.add(
-      "import MarkdownExample from 'components/md/MarkdownExample.vue'"
+      "import MarkdownExample from 'src/.q-press/components/MarkdownExample.vue'"
     );
   }
   if (markdownLinkRE.test(code) === true) {
-    env.pageScripts.add(
-      "import MarkdownLink from 'components/md/MarkdownLink.vue'"
-    );
+    env.pageScripts.add("import MarkdownLink from 'src/.q-press/components/MarkdownLink.vue'");
   }
   const component = getVueComponent(results, code, id, prefix, menu);
   return {
@@ -315,7 +303,8 @@ let globalPrefix = "";
 function transform(code, id) {
   if (!mdRE.test(id)) return null;
   try {
-    return mdParse(code, id, globalPrefix, globalMenu);
+    const result = mdParse(code, id, globalPrefix, globalMenu);
+    return result.code;
   } catch (err) {
     console.error(`Error processing Markdown file: ${id}`, err);
     throw new Error(
@@ -323,16 +312,37 @@ function transform(code, id) {
     );
   }
 }
+function hotUpdate({
+  file,
+  server,
+  modules,
+  timestamp
+}) {
+  if (mdRE.test(file)) {
+    const invalidatedModules = /* @__PURE__ */ new Set();
+    for (const mod of modules) {
+      server.moduleGraph.invalidateModule(mod, invalidatedModules, timestamp, true);
+    }
+    server.ws.send({
+      type: "full-reload",
+      path: file
+    });
+  }
+  return [];
+}
 const mdPlugins = {
-  name: "md-plugins:vitePlugin",
+  name: "@md-plugins/vite-md-plugin",
   enforce: "pre",
-  // before vue
-  transform
+  transform,
+  hotUpdate
 };
-function viteMdPlugin(path, menu) {
+function viteMdPlugin2(path, menu) {
   globalMenu = menu;
   globalPrefix = path;
   return mdPlugins;
 }
+function viteMdPlugin(userConfig) {
+  return viteMdPlugin2(userConfig.path, userConfig.menu);
+}
 
 export { viteMdPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/vite-md-plugin",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.11",
   "description": "A very opinionated Vite plugin for @md-plugins.",
   "keywords": [
     "markdown-it",
@@ -34,27 +34,33 @@
   "files": [
     "./dist"
   ],
+  "dependencies": {
+    "@md-plugins/md-plugin-codeblocks": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-blockquote": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-containers": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-frontmatter": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-headers": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-imports": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-image": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-inlinecode": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-link": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-table": "0.1.0-alpha.11",
+    "@md-plugins/shared": "0.1.0-alpha.11",
+    "@md-plugins/md-plugin-title": "0.1.0-alpha.11"
+  },
   "devDependencies": {
     "@types/markdown-it": "^14.1.2",
     "markdown-it": "^14.1.0",
-    "@md-plugins/shared": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-containers": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-headers": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-frontmatter": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-inlinecode": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-imports": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-table": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-title": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-codeblocks": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-blockquote": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-image": "0.1.0-alpha.1",
-    "@md-plugins/md-plugin-link": "0.1.0-alpha.1"
+    "vite": "^6.0.7"
+  },
+  "peerDependencies": {
+    "markdown-it": "^14.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "unbuild",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist/ node_modules/"
   }
 }