Skip to content

Commit 209d81e

Browse files
author
Dyllan
committed
Update documentation with katex flag
1 parent c021a1f commit 209d81e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The `NotionRenderer` component offers a few properties
2323
- [`pageLinkOptions`](#pageLinkOptions) – default: `undefined`
2424
- [`pageLinkTarget`](#pageLinkTarget) – default: `"_self"`
2525
- [`prism`](#prism) – default: `false`
26+
- [`katex`](#katex) – default: `false`
2627
- [`textLinkTarget`](#textLinkTarget) – default: `"_blank"`
2728

2829
### `blockMap`: Object
@@ -94,6 +95,12 @@ pageLinkOptions: {
9495

9596
> Check the `docs#syntax-highlighting` section below for more details.
9697
98+
### `katex`: Boolean
99+
100+
– whether or not latex rendering using vue-katex should be activated.
101+
102+
> Check the `docs#equations` section below for more details.
103+
97104
### `textLinkTarget`: String
98105

99106
– the [target attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target) of links
@@ -141,6 +148,13 @@ import VueKatex from "vue-katex";
141148
Vue.use(VueKatex);
142149
```
143150

151+
- Add the `katex` flag to the `NotionRenderer`
152+
153+
```diff
154+
-<NotionRenderer :blockMap="blockMap" />
155+
+<NotionRenderer :blockMap="blockMap" katex />
156+
```
157+
144158
> For usage with Nuxt, look at the `/example` (`plugins` in `nuxt.config.js`, `plugins/vue-katex.js`)
145159
146160
## Notion API

0 commit comments

Comments
 (0)