Skip to content

Commit 888f4bd

Browse files
committed
try html anchors
1 parent f43d915 commit 888f4bd

File tree

5 files changed

+22
-19
lines changed

5 files changed

+22
-19
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@
2525
"prettier": "^3.3.3",
2626
"typedoc": "0.27.6",
2727
"typedoc-plugin-frontmatter": "^1.1.2",
28-
"typedoc-plugin-markdown": "^4.3.2"
28+
"typedoc-plugin-markdown": "^4.4.1"
2929
}
3030
}

packages/browser-sdk/typedoc.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
{
22
"tsconfig": "tsconfig.build.json",
3-
"projectDocuments": ["FEEDBACK.md"],
43
}

packages/react-sdk/src/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ export function useTrack() {
236236
* Returns a function to open up the feedback form
237237
* Note: When calling `useRequestFeedback`, user/company must already be set.
238238
*
239-
* See [link](../../browser-sdk/FEEDBACK.md#bucketclient.requestfeedback-options) for more information
239+
* See [link](../../browser-sdk/FEEDBACK.md#bucketclientrequestfeedback-options) for more information
240240
*
241241
* ```ts
242242
* const requestFeedback = useRequestFeedback();

typedoc.json

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"$schema": "https://typedoc-plugin-markdown.org/schema.json",
33

4+
"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"],
5+
46
"entryPointStrategy": "packages",
57
"entryPoints": [
68
"packages/browser-sdk/",
@@ -10,9 +12,10 @@
1012
"packageOptions": {
1113
"entryPoints": ["src/index.ts"]
1214
},
13-
15+
"projectDocuments": ["packages/browser-sdk/FEEDBACK.md"],
1416
"readme": "none",
15-
"disableSources": false,
17+
"useHTMLAnchors": true,
18+
1619
"outputs": [
1720
{
1821
"name": "markdown",
@@ -21,28 +24,29 @@
2124
{
2225
"name": "json",
2326
"path": "./dist/docs/docs.json"
27+
},
28+
{
29+
"name": "html",
30+
"path": "./dist/docs/html"
2431
}
2532
],
33+
"outputFileStrategy": "members",
34+
"membersWithOwnFile": [],
35+
2636
"navigation": {
2737
"includeCategories": false,
2838
"includeGroups": false,
2939
"includeFolders": false,
3040
"excludeReferences": true
3141
},
42+
43+
"disableSources": true,
3244
"categorizeByGroup": false,
3345
"groupReferencesByType": true,
3446
"commentStyle": "block",
35-
36-
"outputFileStrategy": "members",
37-
"membersWithOwnFile": [],
38-
39-
"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-frontmatter"],
40-
4147
"useCodeBlocks": true,
42-
4348
"expandObjects": true,
4449
"expandParameters": true,
45-
4650
"typeDeclarationVisibility": "verbose",
4751

4852
"indexFormat": "htmlTable",
@@ -87,5 +91,5 @@
8791
"pagination": {
8892
"visible": true,
8993
}
90-
}
94+
},
9195
}

yarn.lock

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15222,12 +15222,12 @@ __metadata:
1522215222
languageName: node
1522315223
linkType: hard
1522415224

15225-
"typedoc-plugin-markdown@npm:^4.3.2":
15226-
version: 4.3.2
15227-
resolution: "typedoc-plugin-markdown@npm:4.3.2"
15225+
"typedoc-plugin-markdown@npm:^4.4.1":
15226+
version: 4.4.1
15227+
resolution: "typedoc-plugin-markdown@npm:4.4.1"
1522815228
peerDependencies:
1522915229
typedoc: 0.27.x
15230-
checksum: 10c0/6e66524fabb8087931552477188e47084ce6ce32e8e937c86795bbf821dfad042a9d03d83ecbfbde6b4f94b78c8370f9f8ed1eeec169dca04759ad2f82057e45
15230+
checksum: 10c0/54c9a25aed64d07258033c4d060acac15a618ee0494cbb2bc70fd10d03c82b3434715b6db01fbeb09d672cff736340666d70da1be83188e3a994048a0a0c6b65
1523115231
languageName: node
1523215232
linkType: hard
1523315233

@@ -16289,7 +16289,7 @@ __metadata:
1628916289
prettier: "npm:^3.3.3"
1629016290
typedoc: "npm:0.27.6"
1629116291
typedoc-plugin-frontmatter: "npm:^1.1.2"
16292-
typedoc-plugin-markdown: "npm:^4.3.2"
16292+
typedoc-plugin-markdown: "npm:^4.4.1"
1629316293
languageName: unknown
1629416294
linkType: soft
1629516295

0 commit comments

Comments
 (0)