Skip to content

Commit

Permalink
docs: support twitter card preview
Browse files Browse the repository at this point in the history
  • Loading branch information
rxliuli committed Aug 11, 2024
1 parent 4854098 commit 10cb70d
Show file tree
Hide file tree
Showing 107 changed files with 455 additions and 428 deletions.
11 changes: 10 additions & 1 deletion packages/website/docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
import { defineConfig } from 'vitepress'
import { defineConfig, UserConfig, DefaultTheme } from 'vitepress'
import typedocSidebar from '../en-US/api/typedoc-sidebar.json'
import { readFile } from 'fs/promises'
import path from 'path'
import { twitterMeta } from 'vitepress-plugin-twitter-card'

export default defineConfig({
title: 'Joplin Utils',
Expand Down Expand Up @@ -153,4 +156,10 @@ export default defineConfig({
],
],
ignoreDeadLinks: 'localhostLinks',
extends() {
return twitterMeta({
site: 'rxliuli',
image: 'https://joplin-utils.rxliuli.com/images/logo.png',
})
},
})
4 changes: 2 additions & 2 deletions packages/website/docs/en-US/api/joplin-api/classes/Config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#### Defined in

[util/config.ts:2](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/config.ts#L2)
[util/config.ts:2](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/util/config.ts#L2)

---

Expand All @@ -30,4 +30,4 @@
#### Defined in

[util/config.ts:3](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/util/config.ts#L3)
[util/config.ts:3](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/util/config.ts#L3)
10 changes: 5 additions & 5 deletions packages/website/docs/en-US/api/joplin-api/classes/EventApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ https://joplinapp.org/api/references/rest_api/#events

#### Defined in

[api/EventApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L23)
[api/EventApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/EventApi.ts#L23)

## Methods

Expand Down Expand Up @@ -54,7 +54,7 @@ https://joplinapp.org/api/references/rest_api/#get-events-id

##### Defined in

[api/EventApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L42)
[api/EventApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/EventApi.ts#L42)

#### get(id, fields)

Expand Down Expand Up @@ -82,7 +82,7 @@ https://joplinapp.org/api/references/rest_api/#get-events-id

##### Defined in

[api/EventApi.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L43)
[api/EventApi.ts:43](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/EventApi.ts#L43)

---

Expand Down Expand Up @@ -116,7 +116,7 @@ https://joplinapp.org/api/references/rest_api/#get-events

##### Defined in

[api/EventApi.ts:25](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L25)
[api/EventApi.ts:25](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/EventApi.ts#L25)

#### list(param)

Expand Down Expand Up @@ -146,4 +146,4 @@ https://joplinapp.org/api/references/rest_api/#get-events

##### Defined in

[api/EventApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/EventApi.ts#L26)
[api/EventApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/EventApi.ts#L26)
20 changes: 10 additions & 10 deletions packages/website/docs/en-US/api/joplin-api/classes/FolderApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[api/FolderApi.ts:21](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L21)
[api/FolderApi.ts:21](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L21)

## Methods

Expand All @@ -38,7 +38,7 @@

#### Defined in

[api/FolderApi.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L44)
[api/FolderApi.ts:44](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L44)

---

Expand All @@ -56,7 +56,7 @@

#### Defined in

[api/FolderApi.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L40)
[api/FolderApi.ts:40](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L40)

---

Expand All @@ -72,7 +72,7 @@

##### Defined in

[api/FolderApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L23)
[api/FolderApi.ts:23](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L23)

#### list(pageParam)

Expand All @@ -92,7 +92,7 @@

##### Defined in

[api/FolderApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L24)
[api/FolderApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L24)

---

Expand All @@ -108,7 +108,7 @@

#### Defined in

[api/FolderApi.ts:34](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L34)
[api/FolderApi.ts:34](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L34)

---

Expand All @@ -128,7 +128,7 @@

##### Defined in

[api/FolderApi.ts:57](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L57)
[api/FolderApi.ts:57](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L57)

#### notesByFolderId(id, fields)

Expand All @@ -150,7 +150,7 @@

##### Defined in

[api/FolderApi.ts:58](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L58)
[api/FolderApi.ts:58](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L58)

---

Expand All @@ -168,7 +168,7 @@

#### Defined in

[api/FolderApi.ts:53](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L53)
[api/FolderApi.ts:53](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L53)

---

Expand All @@ -186,4 +186,4 @@

#### Defined in

[api/FolderApi.ts:48](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderApi.ts#L48)
[api/FolderApi.ts:48](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderApi.ts#L48)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[api/FolderExtApi.ts:9](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L9)
[api/FolderExtApi.ts:9](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderExtApi.ts#L9)

## Methods

Expand All @@ -40,7 +40,7 @@

#### Defined in

[api/FolderExtApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L42)
[api/FolderExtApi.ts:42](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderExtApi.ts#L42)

---

Expand All @@ -60,7 +60,7 @@

#### Defined in

[api/FolderExtApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L26)
[api/FolderExtApi.ts:26](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderExtApi.ts#L26)

---

Expand All @@ -82,4 +82,4 @@

#### Defined in

[api/FolderExtApi.ts:18](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/FolderExtApi.ts#L18)
[api/FolderExtApi.ts:18](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/FolderExtApi.ts#L18)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[api/JoplinApi.ts:4](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApi.ts#L4)
[api/JoplinApi.ts:4](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApi.ts#L4)

## Methods

Expand All @@ -32,4 +32,4 @@

#### Defined in

[api/JoplinApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApi.ts#L6)
[api/JoplinApi.ts:6](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApi.ts#L6)
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:36](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L36)
[api/JoplinApiGenerator.ts:36](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L36)

---

Expand All @@ -30,7 +30,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:47](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L47)
[api/JoplinApiGenerator.ts:47](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L47)

---

Expand All @@ -40,7 +40,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:37](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L37)
[api/JoplinApiGenerator.ts:37](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L37)

---

Expand All @@ -50,7 +50,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:38](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L38)
[api/JoplinApiGenerator.ts:38](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L38)

---

Expand All @@ -60,7 +60,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:39](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L39)
[api/JoplinApiGenerator.ts:39](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L39)

---

Expand All @@ -70,7 +70,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:40](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L40)
[api/JoplinApiGenerator.ts:40](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L40)

---

Expand All @@ -80,7 +80,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:41](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L41)
[api/JoplinApiGenerator.ts:41](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L41)

---

Expand All @@ -90,7 +90,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:42](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L42)
[api/JoplinApiGenerator.ts:42](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L42)

---

Expand All @@ -100,7 +100,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:43](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L43)
[api/JoplinApiGenerator.ts:43](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L43)

---

Expand All @@ -110,7 +110,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:44](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L44)
[api/JoplinApiGenerator.ts:44](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L44)

---

Expand All @@ -120,7 +120,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:45](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L45)
[api/JoplinApiGenerator.ts:45](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L45)

---

Expand All @@ -130,7 +130,7 @@
#### Defined in

[api/JoplinApiGenerator.ts:46](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L46)
[api/JoplinApiGenerator.ts:46](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L46)

## Accessors

Expand All @@ -150,7 +150,7 @@

#### Defined in

[api/JoplinApiGenerator.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L24)
[api/JoplinApiGenerator.ts:24](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L24)

---

Expand All @@ -170,4 +170,4 @@

#### Defined in

[api/JoplinApiGenerator.ts:32](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/JoplinApiGenerator.ts#L32)
[api/JoplinApiGenerator.ts:32](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/JoplinApiGenerator.ts#L32)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[api/NoteActionApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L10)
[api/NoteActionApi.ts:10](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/NoteActionApi.ts#L10)

## Methods

Expand All @@ -36,7 +36,7 @@

#### Defined in

[api/NoteActionApi.ts:28](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L28)
[api/NoteActionApi.ts:28](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/NoteActionApi.ts#L28)

---

Expand All @@ -58,7 +58,7 @@

#### Defined in

[api/NoteActionApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L24)
[api/NoteActionApi.ts:24](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/NoteActionApi.ts#L24)

---

Expand All @@ -76,7 +76,7 @@

#### Defined in

[api/NoteActionApi.ts:12](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L12)
[api/NoteActionApi.ts:12](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/NoteActionApi.ts#L12)

---

Expand All @@ -94,4 +94,4 @@

#### Defined in

[api/NoteActionApi.ts:16](https://github.com/rxliuli/joplin-utils/blob/856dd8cbf75fe71932485581a99ca0e4ebcdd5e8/packages/joplin-api/src/api/NoteActionApi.ts#L16)
[api/NoteActionApi.ts:16](https://github.com/rxliuli/joplin-utils/blob/485409801cf7c952cfefe9e29020115fe6abec36/packages/joplin-api/src/api/NoteActionApi.ts#L16)
Loading

0 comments on commit 10cb70d

Please sign in to comment.