Skip to content

Commit 7edbc2f

Browse files
committed
chore(readme): Update with new props
1 parent 7992418 commit 7edbc2f

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,30 @@ Shortcuts (emoticons): :-) :-( 8-) ;)
4949
| Vue Property | Type | Description |
5050
|---|---|---|
5151
| src | String | Pass the markdown as a string instead of a slot |
52+
| no-html | Boolean | Disable HTML tags in source |
53+
| no-linkify | Boolean | Disable auto-convert URL-like text to links |
54+
| no-typographer | Boolean | Disable language-neutral replacement + quotes beautification |
55+
| no-breaks | Boolean | Disable conversion of '\n' into <br> |
56+
| no-highlight | Boolean | Disable code highlighter |
57+
| no-emoji | Boolean | Disable emojie conversion |
58+
| no-subscript | Boolean | Disable subscript conversion |
59+
| no-superscript | Boolean | Disable superscript conversion |
60+
| no-footnote | Boolean | Disable footnote conversion |
61+
| no-deflist | Boolean | Disable deflist conversion |
62+
| no-abbreviation | Boolean | Disable abbreviation conversion |
63+
| no-insert | Boolean | Disable insert conversion |
64+
| no-mark | Boolean | Disable mark conversion |
65+
| no-image | Boolean | Disable image conversion |
66+
| no-tasklist | Boolean | Disable tasklist conversion |
67+
| no-container | Boolean | Disable container conversion |
5268
| toc | Boolean | Generate a TOC; received with `toc` event |
5369
| toc-start | Number | [1-5] The number defines the starting header (ex: 1 == h1, 2 == h2, etc) |
5470
| toc-end | Number | [2-6] The number defines the ending header (ex: 3 == h3, 4 == h4, etc). This number must be greater than the `startingToc` property or it will be ignored |
5571
| task-lists-enable | Boolean | set to true to enable task lists checkboxes (not read-only) |
5672
| task-lists-label | Boolean | to wrap the rendered list items in a <label> element for UX purposes |
5773
| task-lists-enable-after | Boolean | to add the label after the checkbox |
74+
| content-class | [String, Object, Array] | Style definitions to be attributed to the markdown |
75+
| content-style | [String, Object, Array] | Style definitions to be attributed to the markdown |
5876

5977
# QMarkdown Vue Events
6078
| Vue&nbsp;Event | Description |
@@ -63,8 +81,6 @@ Shortcuts (emoticons): :-) :-( 8-) ;)
6381

6482
Given markdown that looks like this:
6583
```
66-
# h1 Heading 8-)
67-
6884
## h2 Heading
6985
7086
### h3 Heading
@@ -73,8 +89,8 @@ Given markdown that looks like this:
7389
The TOC data looks like this:
7490
```
7591
[
76-
{id:`h2-Heading`,title:`h2 Heading`, level: 2},
77-
{id:`h3-Heading`,title:`h3 Heading`, level: 3}
92+
{id: 'h2-Heading', title: 'h2 Heading', level: 2},
93+
{id: 'h3-Heading', title: 'h3 Heading', level: 3}
7894
]
7995
```
8096

0 commit comments

Comments
 (0)