Skip to content

Commit 1584dfb

Browse files
committed
docs: better typedocs
1 parent bfc6ddb commit 1584dfb

File tree

13 files changed

+62
-4
lines changed

13 files changed

+62
-4
lines changed

package-lock.json

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@
109109
"ts-node": "10.9.2",
110110
"typedoc": "0.28.1",
111111
"typedoc-plugin-missing-exports": "^4.0.0",
112+
"typedoc-plugin-rename-defaults": "^0.7.3",
112113
"typescript": "5.8.2",
113114
"typescript-eslint": "^8.18.2"
114115
},

packages/h5p-clamav-scanner/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
const config = {
33
entryPoints: ["./src/ClamAVScanner.ts"],
44
out: "doc",
5+
externalPattern: [
6+
"**/node_modules/**", "**/packages/!(h5p-clamav-scanner)/**"
7+
],
58
};
69

710
export default config;

packages/h5p-express/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
const config = {
33
entryPoints: ["./src/index.ts"],
44
out: "doc",
5+
externalPattern: [
6+
"**/node_modules/**", "**/packages/!(h5p-express)/**"
7+
],
58
};
69

710
export default config;

packages/h5p-html-exporter/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
const config = {
33
entryPoints: ["./src/HtmlExporter.ts"],
44
out: "doc",
5+
externalPattern: [
6+
"**/node_modules/**", "**/packages/!(h5p-html-exporter)/**"
7+
],
58
};
69

710
export default config;

packages/h5p-mongos3/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ const config = {
66
],
77
alwaysCreateEntryPointModule: false,
88
out: "doc",
9+
externalPattern: [
10+
"**/node_modules/**", "**/packages/!(h5p-mongos3)/**"
11+
],
912
};
1013

1114
export default config;

packages/h5p-react/typedoc.config.mjs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ const config = {
44
out: "doc",
55
compilerOptions: {
66
resolveJsonModule: true,
7-
}
7+
},
8+
externalPattern: [
9+
"**/node_modules/**", "**/packages/!(h5p-react)/**"
10+
],
811
};
912

1013
export default config;

packages/h5p-redis-lock/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
const config = {
33
entryPoints: ["./src/RedisLockProvider.ts"],
44
out: "doc",
5+
externalPattern: [
6+
"**/node_modules/**", "**/packages/!(h5p-redis-lock)/**"
7+
],
58
};
69

710
export default config;

packages/h5p-server/typedoc.config.mjs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ const config = {
44
out: "doc",
55
compilerOptions: {
66
resolveJsonModule: true,
7-
}
7+
},
8+
externalPattern: [
9+
"**/node_modules/**", "**/packages/!(h5p-server)/**"
10+
],
811
};
912

1013
export default config;

packages/h5p-shared-state-server/typedoc.config.mjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
const config = {
33
entryPoints: ["./src/SharedStateServer.ts"],
44
out: "doc",
5+
externalPattern: [
6+
"**/node_modules/**", "**/packages/!(h5p-shared-state-server)/**"
7+
],
58
};
69

710
export default config;

0 commit comments

Comments
 (0)