[READ-ONLY] Mirror of https://github.com/FoxxMD/logging. A typed, opinionated, batteries-included, Pino-based logging solution for backend TS/JS projects
foxxmd.github.io/logging
child-logger
logging
logging-library
nodejs
pinojs
typescript-library
docs: Fix readme image by using replace typedoc plugin
+39
-20
+1
-2
README.md
+1
-2
README.md
+10
package-lock.json
+10
package-lock.json
···
35
35
"tshy": "^1.7.0",
36
36
"typedoc": "^0.25.11",
37
37
"typedoc-plugin-missing-exports": "^2.2.0",
38
+
"typedoc-plugin-replace-text": "^3.3.0",
38
39
"typescript": "^5.3.3",
39
40
"with-local-tmp-dir": "^5.0.1",
40
41
"yaml": "^2.3.4"
···
3155
3156
"dev": true,
3156
3157
"peerDependencies": {
3157
3158
"typedoc": "0.24.x || 0.25.x"
3159
+
}
3160
+
},
3161
+
"node_modules/typedoc-plugin-replace-text": {
3162
+
"version": "3.3.0",
3163
+
"resolved": "https://registry.npmjs.org/typedoc-plugin-replace-text/-/typedoc-plugin-replace-text-3.3.0.tgz",
3164
+
"integrity": "sha512-Bn2bodwpbj98sYzcVMXjbeDdempncHY7jEvP9MCX4e5IfjO0xCaRAHIlpH+UoqqhB+4B1mc599E22W67kvua1w==",
3165
+
"dev": true,
3166
+
"peerDependencies": {
3167
+
"typedoc": "^0.24.8 || 0.25.x"
3158
3168
}
3159
3169
},
3160
3170
"node_modules/typedoc/node_modules/minimatch": {
+2
-1
package.json
+2
-1
package.json
···
5
5
"repository": "https://github.com/foxxmd/logging",
6
6
"description": "",
7
7
"scripts": {
8
-
"typedoc": "typedoc --plugin typedoc-plugin-missing-exports --media ./assets",
8
+
"typedoc": "typedoc --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-replace-text --media ./assets",
9
9
"build": "tsc",
10
10
"prepare": "tshy",
11
11
"test": "mocha --reporter spec --recursive ./tests/*.test.ts",
···
52
52
"tshy": "^1.7.0",
53
53
"typedoc": "^0.25.11",
54
54
"typedoc-plugin-missing-exports": "^2.2.0",
55
+
"typedoc-plugin-replace-text": "^3.3.0",
55
56
"typescript": "^5.3.3",
56
57
"with-local-tmp-dir": "^5.0.1",
57
58
"yaml": "^2.3.4"
+26
typedoc.config.cjs
+26
typedoc.config.cjs
···
1
+
/** @type { import('typedoc').TypeDocOptionMap & import('typedoc-plugin-replace-text').Config } */
2
+
module.exports ={
3
+
name: "@foxxmd/logging Docs",
4
+
entryPoints: [
5
+
"./src/index.ts",
6
+
"./src/factory.ts"
7
+
],
8
+
sort: ["source-order"],
9
+
categorizeByGroup: false,
10
+
searchGroupBoosts: {
11
+
"Functions": 1.5
12
+
},
13
+
navigationLinks: {
14
+
"Docs": "http://foxxmd.github.io/logging",
15
+
"GitHub": "https://github.com/foxxmd/logging"
16
+
},
17
+
replaceText: {
18
+
inIncludedFiles: true,
19
+
replacements: [
20
+
{
21
+
pattern: "\/assets\/",
22
+
replace: "media://"
23
+
}
24
+
]
25
+
}
26
+
}
-17
typedoc.json
-17
typedoc.json
···
1
-
{
2
-
"$schema": "https://typedoc.org/schema.json",
3
-
"name": "@foxxmd/logging Docs",
4
-
"entryPoints": [
5
-
"./src/index.ts",
6
-
"./src/factory.ts"
7
-
],
8
-
"sort": ["source-order"],
9
-
"categorizeByGroup": false,
10
-
"searchGroupBoosts": {
11
-
"Functions": 1.5
12
-
},
13
-
"navigationLinks": {
14
-
"Docs": "http://foxxmd.github.io/logging",
15
-
"GitHub": "https://github.com/foxxmd/logging"
16
-
}
17
-
}