@md-plugins/quasar-app-extension-vite-md-plugin 0.1.0-rc.8 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -12
- package/package.json +4 -4
- package/src/index.js +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,17 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @md-plugins/quasar-app-extension-vite-md-plugin
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@md-plugins/quasar-app-extension-vite-md-plugin)
|
|
4
|
+
[](https://www.npmjs.com/package/@md-plugins/quasar-app-extension-vite-md-plugin)
|
|
5
|
+
[](https://www.npmjs.com/package/@md-plugins/quasar-app-extension-vite-md-plugin)
|
|
6
|
+
[](https://www.npmjs.com/package/@md-plugins/quasar-app-extension-vite-md-plugin)
|
|
7
|
+
|
|
8
|
+
<span class="badge-github-sponsors"><a href="https://github.com/sponsors/hawkeye64" title="Sponsor this project on GitHub"><img src="https://img.shields.io/badge/github-sponsors-ea4aaa.svg?logo=githubsponsors&logoColor=white" alt="GitHub Sponsors button" /></a></span>
|
|
9
|
+
<span class="badge-paypal"><a href="https://paypal.me/hawkeye64" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
|
|
10
|
+
|
|
11
|
+
[](https://chat.quasar.dev)
|
|
12
|
+
[](https://twitter.com/jgalbraith64)
|
|
13
|
+
|
|
14
|
+
This Quasar App Extension wires `@md-plugins/vite-md-plugin` into a Quasar Vite app so Markdown files can be compiled as Vue pages. It is the lightweight Markdown route option when you want the Markdown transform without the full Q-Press documentation shell.
|
|
4
15
|
|
|
5
16
|
## Table of Contents
|
|
6
17
|
|
|
@@ -13,17 +24,17 @@ The `viteMdPluginAppExt` is a Quasar App Extension that integrates the `viteMdPl
|
|
|
13
24
|
|
|
14
25
|
## Overview
|
|
15
26
|
|
|
16
|
-
The
|
|
27
|
+
The extension adds the Markdown-to-Vue transform, configures Quasar to compile `.md` files, and gives content-heavy Quasar apps a smaller path than adopting Q-Press. Use it for custom docs, content pages, release notes, or internal knowledge-base routes where your app owns the layout and navigation.
|
|
17
28
|
|
|
18
|
-
This App
|
|
29
|
+
This App Extension is for convenience only. For more granular control, use `viteMdPlugin` directly in your Vite configuration. For the full generated docs-site experience, use Q-Press instead. For more information, refer to the [viteMdPlugin documentation](https://github.com/md-plugins/md-plugins/tree/dev/packages/viteMdPlugin).
|
|
19
30
|
|
|
20
|
-
> Current release
|
|
31
|
+
> Current stable release: `1.0.0`.
|
|
21
32
|
>
|
|
22
|
-
> This app extension currently targets Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-rc.
|
|
33
|
+
> This app extension currently targets Quasar Vite projects using `@quasar/app-vite` `>=3.0.0-rc.6`.
|
|
23
34
|
|
|
24
35
|
## Installation
|
|
25
36
|
|
|
26
|
-
To install the
|
|
37
|
+
To install the extension, use the following command:
|
|
27
38
|
|
|
28
39
|
```bash
|
|
29
40
|
quasar ext add @md-plugins/vite-md-plugin
|
|
@@ -31,11 +42,12 @@ quasar ext add @md-plugins/vite-md-plugin
|
|
|
31
42
|
|
|
32
43
|
## What It Does
|
|
33
44
|
|
|
34
|
-
The
|
|
45
|
+
The extension does the following:
|
|
35
46
|
|
|
36
|
-
- Integrates
|
|
37
|
-
- Allows you to use Markdown files as Vue components.
|
|
38
|
-
-
|
|
47
|
+
- Integrates `viteMdPlugin` into your Quasar project.
|
|
48
|
+
- Allows you to use Markdown files as Vue page components.
|
|
49
|
+
- Configures Quasar to compile `.md` files beside Vue SFCs.
|
|
50
|
+
- Leaves layout, routing, navigation, search, and SSG decisions in your app.
|
|
39
51
|
- Provides `quasar.config` changes so you don't have to manage the small things. Here is what it changes:
|
|
40
52
|
|
|
41
53
|
```javascript
|
|
@@ -80,7 +92,7 @@ const { sidebar } = siteConfig
|
|
|
80
92
|
|
|
81
93
|
## Configuration
|
|
82
94
|
|
|
83
|
-
The
|
|
95
|
+
The extension can be customized through the underlying Vite and Quasar configuration. Here are some of the key configuration options:
|
|
84
96
|
|
|
85
97
|
- **`vueRouterMode`**: Set to `'history'` for proper hash link handling.
|
|
86
98
|
- **`viteVuePluginOptions.include`**: Include Markdown files for Vite to transpile.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@md-plugins/quasar-app-extension-vite-md-plugin",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "A Quasar app-ext for @md-plugins/viteMdPlugin",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"app extension",
|
|
@@ -17,11 +17,11 @@
|
|
|
17
17
|
"access": "public"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|
|
20
|
-
"@quasar/app-vite": "3.0.0-rc.
|
|
21
|
-
"@md-plugins/vite-md-plugin": "
|
|
20
|
+
"@quasar/app-vite": "3.0.0-rc.6",
|
|
21
|
+
"@md-plugins/vite-md-plugin": "1.0.0"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
|
-
"@quasar/app-vite": ">=3.0.0-rc.
|
|
24
|
+
"@quasar/app-vite": ">=3.0.0-rc.6"
|
|
25
25
|
},
|
|
26
26
|
"engines": {
|
|
27
27
|
"node": ">=22.13",
|
package/src/index.js
CHANGED
|
@@ -33,7 +33,7 @@ function extendConfig(config) {
|
|
|
33
33
|
|
|
34
34
|
export default defineIndexScript((api) => {
|
|
35
35
|
api.compatibleWith('quasar', '^2.0.0')
|
|
36
|
-
api.compatibleWith('@quasar/app-vite', '>=3.0.0-rc.
|
|
36
|
+
api.compatibleWith('@quasar/app-vite', '>=3.0.0-rc.5')
|
|
37
37
|
|
|
38
38
|
// here we extend /quasar.config, so we can add some Vite/Vue stuff
|
|
39
39
|
api.extendQuasarConf(extendConfig)
|