Skip to content

Commit db018e8

Browse files
committed
typedoc config
1 parent ea4149c commit db018e8

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed
File renamed without changes.

docs-assets/custom-styles.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/* Remove ugly square in bottom-right corner when scroll shows up. */
2+
*::-webkit-scrollbar {
3+
width: 0px;
4+
}
5+
6+
/* Add margin after code. */
7+
.tsd-comment {
8+
margin-bottom: 2em;
9+
}
10+
11+
/* Avoid word wrapping when code doesn't fit into avaiable width. */
12+
.tsd-comment > pre {
13+
white-space: pre;
14+
overflow: scroll;
15+
}
16+
17+
/* Remove ugly border radius in code. */
18+
.tsd-comment > pre,
19+
.tsd-comment > code {
20+
border-radius: 0px;
21+
}

typedoc.config.mjs

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/**
2+
* Configuration for Typedoc.
3+
*/
4+
5+
/** @type {Partial<import('typedoc').TypeDocOptions>} */
6+
const config = {
7+
entryPoints: ['src/JsSIP.ts'],
8+
out: 'docs',
9+
skipErrorChecking: false,
10+
exclude: ['src/**/*.d.ts', 'src/test/**/test-*.ts'],
11+
excludePrivate: true,
12+
excludeProtected: true,
13+
excludeNotDocumented: true,
14+
excludeInternal: true,
15+
excludeExternals: true,
16+
includeVersion: true,
17+
gitRemote: 'origin',
18+
hideGenerator: false,
19+
treatWarningsAsErrors: true,
20+
cacheBust: true,
21+
categorizeByGroup: false,
22+
categoryOrder: ['Config', 'UA', 'RTCSession', '*'],
23+
searchInComments: true,
24+
readme: 'README.md',
25+
projectDocuments: ['README.md', 'LICENSE.md'],
26+
navigationLinks: {
27+
GitHub: 'https://github.com/versatica/jssip',
28+
NPM: 'https://www.npmjs.com/package/jssip',
29+
},
30+
customCss: './docs-assets/custom-styles.css',
31+
};
32+
33+
export default config;

0 commit comments

Comments
 (0)