@md-plugins/vite-md-plugin 0.1.0-alpha.2 → 0.1.0-alpha.21

package/README.md

@@ -55,7 +55,7 @@ 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 })],
 })
 ```
 
@@ -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[],
+        },
+      ],
     // ...
   ],
 },
@@ -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

@@ -34,15 +34,20 @@ interface RelatedItem {
     category: string;
     path: string;
 }
+interface UserConfig {
+    path: string;
+    menu: MenuItem[];
+}
 
 /**
- * Creates a Vite plugin for processing Markdown files.
- * This plugin transforms Markdown content into Vue Single File Components (SFCs).
+ * 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 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.
+ * @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 viteMdPlugin(path: string, menu: MenuItem[]): Plugin;
+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

@@ -34,15 +34,20 @@ interface RelatedItem {
     category: string;
     path: string;
 }
+interface UserConfig {
+    path: string;
+    menu: MenuItem[];
+}
 
 /**
- * Creates a Vite plugin for processing Markdown files.
- * This plugin transforms Markdown content into Vue Single File Components (SFCs).
+ * 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 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.
+ * @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 viteMdPlugin(path: string, menu: MenuItem[]): Plugin;
+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

@@ -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);
@@ -164,12 +164,12 @@ function createNav(id, env, flatMenu) {
   if (flatMenu) {
     const menuItem = flatMenu[id];
     const nav = [];
-    if (menuItem !== void 0) {
+    if (menuItem !== undefined) {
       const { prev, next } = menuItem;
-      if (prev !== void 0) {
+      if (prev !== undefined) {
         nav.push({ ...prev, classes: "markdown-page__related--left" });
       }
-      if (next !== void 0) {
+      if (next !== undefined) {
         nav.push({ ...next, classes: "markdown-page__related--right" });
       }
     }
@@ -209,7 +209,7 @@ 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;
@@ -221,7 +221,6 @@ function getVueComponent(rendered, code, id, prefix, menu) {
   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);
@@ -243,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
@@ -260,7 +259,6 @@ ${pageScripts}
 
 const markdownLinkRE = /<MarkdownLink /;
 const markdownApiRE = /<MarkdownApi /;
-const markdownInstallationRE = /<MarkdownInstallation /;
 const markdownTreeRE = /<MarkdownTree /;
 function mdParse(code, id, prefix, menu) {
   const env = {
@@ -269,24 +267,21 @@ 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'");
-  }
-  if (markdownInstallationRE.test(code) === true) {
-    env.pageScripts.add(
-      "import MarkdownInstallation from 'components/md/MarkdownInstallation.vue'"
-    );
+    env.pageScripts.add("import MarkdownApi from 'src/.q-press/components/MarkdownApi.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'");
+  if (env.frontmatter.examples !== undefined) {
+    env.pageScripts.add(
+      "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 {
@@ -324,23 +319,24 @@ function hotUpdate({
     }
     server.ws.send({
       type: "full-reload",
-      path: "*"
+      path: file
     });
   }
   return [];
 }
 const mdPlugins = {
-  name: "md-plugins:vitePlugin",
+  name: "@md-plugins/vite-md-plugin",
   enforce: "pre",
-  // before vue
   transform,
-  // handleHotUpdate,
   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.2",
+  "version": "0.1.0-alpha.21",
   "description": "A very opinionated Vite plugin for @md-plugins.",
   "keywords": [
     "markdown-it",
@@ -35,21 +35,26 @@
     "./dist"
   ],
   "dependencies": {
-    "@types/markdown-it": "^14.1.2",
     "markdown-it": "^14.1.0",
-    "vite": "^6.0.6",
-    "@md-plugins/md-plugin-blockquote": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-containers": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-codeblocks": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-frontmatter": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-imports": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-image": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-headers": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-link": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-inlinecode": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-table": "0.1.0-alpha.2",
-    "@md-plugins/md-plugin-title": "0.1.0-alpha.2",
-    "@md-plugins/shared": "0.1.0-alpha.2"
+    "@md-plugins/md-plugin-blockquote": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-codeblocks": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-containers": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-headers": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-frontmatter": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-image": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-inlinecode": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-imports": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-link": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-table": "0.1.0-alpha.21",
+    "@md-plugins/md-plugin-title": "0.1.0-alpha.21",
+    "@md-plugins/shared": "0.1.0-alpha.21"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "vite": "^6.0.7"
+  },
+  "peerDependencies": {
+    "markdown-it": "^14.1.0"
   },
   "publishConfig": {
     "access": "public"