Skip to content

Commit 91b1442

Browse files
committed
chore(docs): updated
1 parent c1231f2 commit 91b1442

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

docs/src/pages/all-about-qmarkdown/installation-types.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ compilerOptions: {
2323

2424
As mentioned, this is buggy at the time of this writing. However, there is another way.
2525

26-
If using Quasar, and you did not install via the QMarkdown app-extension, then you need to modify your quasar.conf.js in the following way:
26+
If using Quasar, and you did not install via the QMarkdown app-extension, then you need to modify your quasar.conf.js in the following ways, depending on using webpack (app-webpack) or vite (app-vite):
27+
28+
**app-webpack:**
2729

2830
```js
2931
build: {
@@ -35,7 +37,21 @@ build: {
3537
}
3638
```
3739

38-
For Vue CLI and Vite, you will need to extrapolate this to fit your needs.
40+
**app-vite:**
41+
42+
```js
43+
build: {
44+
viteVuePluginOptions: {
45+
template: {
46+
compilerOptions: {
47+
isPreTag: (tag) => tag === 'pre ' || tag === 'q-markdown'
48+
}
49+
}
50+
}
51+
}
52+
```
53+
54+
For the Vue CLI, you will need to extrapolate this to fit your needs.
3955

4056
## Quasar CLI
4157

@@ -48,6 +64,8 @@ To add as an App Extension to your Quasar application, run the following (in you
4864
$ quasar ext add @quasar/qmarkdown@next
4965
```
5066

67+
Notice the `@next` for Quasar v2 supported version.
68+
5169
#### Uninstall
5270

5371
To remove as an App Extension from your Quasar application, run the following (in your Quasar app folder):
@@ -110,7 +128,6 @@ build: {
110128

111129
### Or target as a component import
112130

113-
:::
114131
```html
115132
<style src="@quasar/quasar-ui-qmarkdown/dist/QMarkdown.min.css"></style>
116133

@@ -124,12 +141,10 @@ export default {
124141
}
125142
</script>
126143
```
127-
:::
128144

129145
## Vue CLI or Vite
130146
### Vue project from src
131147

132-
:::
133148
```js
134149
import Plugin from '@quasar/quasar-ui-qmarkdown/src/QMarkdown.js'
135150
import '@quasar/quasar-ui-qmarkdown/src/QMarkdown.sass'
@@ -138,11 +153,9 @@ import App from './App.vue'
138153
const app = createApp(App)
139154
.use(Plugin)
140155
```
141-
:::
142156

143157
### Vue project from dist
144158

145-
:::
146159
```js
147160
import Plugin from '@quasar/quasar-ui-qmarkdown/dist/QMarkdown.esm.js'
148161
import '@quasar/quasar-ui-qmarkdown/dist/QMarkdown.min.css'
@@ -151,11 +164,9 @@ import App from './App.vue'
151164
const app = createApp(App)
152165
.use(Plugin)
153166
```
154-
:::
155167

156168
### Or component import
157169

158-
:::
159170
```html
160171
<style src="@quasar/quasar-ui-qmarkdown/dist/QMarkdown.min.css"></style>
161172

@@ -169,7 +180,6 @@ export default {
169180
}
170181
</script>
171182
```
172-
:::
173183

174184
## UMD variant
175185

docs/src/pages/developing/using-qmarkdown.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,9 @@ QMarkdown has a number of built-in processors to handle inline markdown. These a
151151

152152
## Extending with Plugins
153153

154-
In order to reduce the payload size of QMarkdown and to increase performance, a lot of the "default" markdown-it plugins have been removed. If you have the need, you can add them back either via the `plugins` property or the global props, as descibed above.
154+
In order to reduce the payload size of QMarkdown and to increase performance, a lot of the "default" markdown-it plugins have been removed for v2.0.0+. If you have the need, you can add them back either via the `plugins` property or the global props, as descibed above.
155155

156-
Here is a list of plugins that used to be in QMarkdown:
156+
Here is a list of plugins that used to be in QMarkdown v1.x:
157157

158158
```
159159
import abbreviation from 'markdown-it-abbr'

0 commit comments

Comments
 (0)