Skip to content

Commit e39b952

Browse files
committed
chore(docs): updated text
1 parent 8149e91 commit e39b952

File tree

2 files changed

+35
-31
lines changed

2 files changed

+35
-31
lines changed

docs/src/pages/all-about-qmarkdown/what-is-qmarkdown.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,47 @@ QMarkdown allows you to write markdown via slotted content (or a `src` property)
2424

2525
## Features
2626

27-
1. Abbreviations
28-
2. Blockquotes
29-
3. Code blocks (with copy to clipboard and line numbers support)
30-
4. Containers
31-
5. Definition lists
32-
6. Emojies
33-
7. Emphasis
34-
8. Footnotes
35-
10. Headings
36-
11. Horizontal rules
37-
12. Insert
38-
13. Links (specific and magic links)
39-
14. Lists
40-
15. Mark
41-
16. Subscript/superscript
42-
17. Tables
43-
18. Task lists
44-
19. Titles
45-
20. Typography
27+
1. Blockquotes
28+
2. Code blocks (with copy to clipboard and line numbers support)
29+
3. Containers
30+
4. Emphasis
31+
5. Headings
32+
6. Horizontal rules
33+
7. Links (specific and magic links)
34+
8. Lists
35+
9. Tables
36+
10. Titles
37+
11. Typography
4638

4739
QMarkdown is also extensible via the `plugins` property.
4840

49-
## GlobalProperties
41+
Try out these fine plugins for additional functionality:
5042

51-
For all properties that can be used on QMarkdown, you can set the global properties via the `useQMarkdownGlobalProps` function.
43+
1. [Abbreviations](https://www.npmjs.com/package/markdown-it-abbr)
44+
2. [Definition lists](https://www.npmjs.com/package/markdown-it-deflist)
45+
3. [Emojies](https://www.npmjs.com/package/markdown-it-emoji)
46+
4. [Footnotes](https://www.npmjs.com/package/markdown-it-footnote)
47+
5. [Insert](https://www.npmjs.com/package/markdown-it-ins)
48+
6. [Mark](https://www.npmjs.com/package/markdown-it-mark)
49+
7. [Subscript](https://www.npmjs.com/package/markdown-it-sub)/[Superscript](https://www.npmjs.com/package/markdown-it-sup)
50+
8. [Task lists](https://www.npmjs.com/package/markdown-it-task-lists)
51+
9. [Mermaid](https://www.npmjs.com/package/@datatraccorporation/markdown-it-mermaid)
5252

53-
Here is an example using the `markdown`-it-mermaid` plugin:
53+
54+
## Global Properties
55+
56+
For all properties that can be used with QMarkdown, you can set the global properties via the `useQMarkdownGlobalProps` function.
57+
58+
Here is an example using the `markdown-it-mermaid` plugin from a boot file:
5459

5560
```js
5661
import { useQMarkdownGlobalProps } from '@quasar/quasar-ui-qmarkdown'
57-
import markdownItMermaid from '@datatraccorporation/markdown-it-mermaid'
62+
import mermaid from '@datatraccorporation/markdown-it-mermaid'
5863

5964
// defaults for QMarkdown
6065
useQMarkdownGlobalProps({
61-
plugins: [markdownItMermaid]
66+
plugins: [mermaid]
6267
})
6368
```
6469

70+
The `markdown-it-mermaid` plugin is now globally available wherever you use QMarkdown.

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `prismjs` package is used for language highlighting. When Prism is installed
1616

1717
## Global Properties
1818

19-
QMarkdown has the ability to set some global properties via the `useQMarkdownGlobalProps` function.
19+
QMarkdown has the ability to set global properties via the `useQMarkdownGlobalProps` function.
2020

2121
To set it up site wide, put it into a boot file. The function takes an object containing the **camelCase** naming of the props for QMarkdown.
2222

@@ -29,20 +29,18 @@ import { useQMarkdownGlobalProps } from '@quasar/quasar-ui-qmarkdown'
2929

3030
// defaults for QMarkdown
3131
useQMarkdownGlobalProps({
32-
noAbbreviation: true,
33-
noBlockquote: true
32+
noLineNumbers: true,
33+
lineNumberAlt: '$'
3434
})
3535
```
3636

37-
Essentially, the above code makes it so that QMarkdown will no longer render `abbreviations` or `block quotes`.
38-
3937
::: warning
4038
The keys are not validated in any way, so make sure to adhere to the proper type, for that property, to avoid issues.
4139
:::
4240

4341
## Global Plugins
4442

45-
As well, a new property, `plugins`, has been added to replace the `extend` property. In the case of using it in the globalproperties, you can do something like this in a boot file:
43+
As well, the property, `plugins`, has been added to enhance QMarkdown with `markdown-it` plugins. You can do something like this in a boot file:
4644

4745
```js
4846
import { useQMarkdownGlobalProps } from '@quasar/quasar-ui-qmarkdown'
@@ -56,7 +54,7 @@ useQMarkdownGlobalProps({
5654

5755
In this case, the `markdown-it-mermaid` will be made available to all QMarkdown instances.
5856

59-
## Native QMarkdown
57+
## QMarkdown Native Handling
6058

6159
QMarkdown has a number of built-in processors to handle inline markdown. These are listed below:
6260

0 commit comments

Comments
 (0)