Skip to content

Commit 93fee30

Browse files
committed
Update docs
1 parent 0d060f9 commit 93fee30

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,10 @@ export default {
7373

7474
## Docs
7575

76-
<!-- todo: add # links to doc links -->
77-
78-
- `NotionRenderer`: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs)
79-
- Syntax Highlighting in Code Blocks (with Prism.js): [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs)
80-
- Notion API: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs)
81-
- Nuxt: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs)
76+
- `NotionRenderer`: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#notionrenderer)
77+
- Syntax-Highlighting in Code Blocks (with Prism.js): [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#syntax-highlighting)
78+
- Notion API: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#notion-api)
79+
- Nuxt: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#nuxtjs--server-side-rendering--static-site-generation)
8280

8381
> Check out a full working demo at [vue-notion.now.sh](https://vue-notion.now.sh/)
8482
> The code for the demo is in [`example/`](https://github.com/janniks/vue-notion/tree/main/example).

docs/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Docs
22

3-
## vue-notion `NotionRenderer`
3+
- `NotionRenderer`: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#notionrenderer)
4+
- Syntax-Highlighting in Code Blocks (with Prism.js): [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#syntax-highlighting)
5+
- Notion API: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#notion-api)
6+
- Nuxt: [`docs/`](https://github.com/janniks/vue-notion/tree/main/docs#nuxtjs--server-side-rendering--static-site-generation)
7+
8+
> Check out a full working demo at [vue-notion.now.sh](https://vue-notion.now.sh/)
9+
> The code for the demo is in [`example/`](https://github.com/janniks/vue-notion/tree/main/example).
10+
11+
## `NotionRenderer`
412

513
The `NotionRenderer` component offers a few properties
614

@@ -72,7 +80,7 @@ pageLinkOptions: {
7280

7381
> Check the `docs#syntax-highlighting` section below for more details.
7482
75-
## Syntax-highlighting
83+
## Syntax-Highlighting
7684

7785
The following steps are required to add syntax-highlighting using Prism.js
7886

0 commit comments

Comments
 (0)