@md-plugins/quasar-app-extension-vite-md-plugin 0.1.0-alpha.9 → 0.1.0-beta.1

package/README.md

@@ -17,12 +17,16 @@ The `viteMdPluginAppExt` extension provides a convenient way to use Markdown fil
 
 This App-Extension (app-ext) is for convenience only. For more granular control, you can use the `viteMdPlugin` directly in your Vite configuration. For more information, refer to the [viteMdPlugin documentation](https://github.com/md-plugins/md-plugins/tree/dev/packages/viteMdPlugin).
 
+> Current beta release: `0.1.0-beta.1`.
+>
+> This app extension currently targets Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-beta.14`.
+
 ## Installation
 
 To install the `viteMdPluginAppExt` extension, use the following command:
 
 ```bash
-pnpm add @md-plugins/vite-md-plugin-app-ext
+quasar ext add @md-plugins/vite-md-plugin
 ```
 
 ## What It Does
@@ -48,9 +52,9 @@ framework: {
 
 After installing the extension, you need to configure it in your Quasar project. Here are the steps to get started:
 
-1. **Import `@md-plugins/vite-md-plugin`:**
+1. **Import `viteMdPlugin`:**
 
-   Update your `quasar.config.js` or `quasar.config.ts` to include the `@md-plugins/vite-md-plugin` extension:
+   Update your `quasar.config.js` or `quasar.config.ts` to include the `@md-plugins/vite-md-plugin` package:
 
 ```js
 import { viteMdPlugin, type MenuItem } from '@md-plugins/vite-md-plugin'
@@ -67,7 +71,10 @@ const { sidebar } = siteConfig
 
 ```js
       vitePlugins: [
-        viteMdPlugin(ctx.appPaths.srcDir + '/markdown', sidebar as MenuItem[]),
+        viteMdPlugin({
+          path: ctx.appPaths.srcDir + '/markdown',
+          menu: sidebar as MenuItem[],
+        }),
         // ...
 ```
 
@@ -79,6 +86,10 @@ The `viteMdPluginAppExt` extension can be customized through various options. He
 - **`viteVuePluginOptions.include`**: Include Markdown files for Vite to transpile.
 - **`framework.autoImportVueExtensions`**: Enable auto-import for Markdown extensions.
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/quasar-app-extensions/vite-md-plugin-app-ext/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/package.json

@@ -1,29 +1,31 @@
 {
   "name": "@md-plugins/quasar-app-extension-vite-md-plugin",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.1",
   "description": "A Quasar app-ext for @md-plugins/viteMdPlugin",
-  "author": "Jeff <galbraith64@gmail.com>",
-  "license": "MIT",
-  "type": "module",
-  "engines": {
-    "node": ">= 20",
-    "npm": ">= 5.6.0",
-    "yarn": ">= 1.6.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
   "keywords": [
-    "quasar",
-    "app",
     "app extension",
     "extension",
     "markdown",
     "md-plugins",
+    "quasar",
     "viteMdPlugin"
   ],
-  "dependencies": {
-    "@md-plugins/vite-md-plugin": "0.1.0-alpha.9"
+  "license": "MIT",
+  "author": "Jeff <galbraith64@gmail.com>",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@quasar/app-vite": "3.0.0-beta.14",
+    "@md-plugins/vite-md-plugin": "0.1.0-beta.1"
+  },
+  "peerDependencies": {
+    "@quasar/app-vite": ">=3.0.0-beta.14"
+  },
+  "engines": {
+    "node": ">=22.13",
+    "pnpm": ">=11.1.0"
   },
   "scripts": {
     "test": "echo \"No test specified\" && exit 0"

package/src/index.js

@@ -1,4 +1,3 @@
-/*global console*/
 /**
  * Quasar App Extension index/runner script
  * (runs on each dev/build)
@@ -6,10 +5,12 @@
  * Docs: https://quasar.dev/app-extensions/development-guide/index-api
  */
 
+import { defineIndexScript } from '@quasar/app-vite'
+
 function extendConfig(config) {
   // make sure 'vueRouterMode' has 'history' mode
   if (config.build.vueRouterMode !== 'history') {
-    console.log('Changing vueRouterMode to "history" - required for hash links to work correctly')
+    console.warn('Changing vueRouterMode to "history" - required for hash links to work correctly')
     config.build.vueRouterMode = 'history'
   }
 
@@ -24,15 +25,15 @@ function extendConfig(config) {
   config.framework.autoImportVueExtensions = Array.from(extensions)
 }
 
-export default function (api) {
+export default defineIndexScript((api) => {
   // verify this is a Vite project
   if (!api.hasVite) {
     throw new Error('This extension requires Vite')
   }
 
   api.compatibleWith('quasar', '^2.0.0')
-  api.compatibleWith('@quasar/app-vite', '^2.0.0')
+  api.compatibleWith('@quasar/app-vite', '>=3.0.0-beta.14')
 
   // here we extend /quasar.config, so we can add some Vite/Vue stuff
   api.extendQuasarConf(extendConfig)
-}
+})