web-ui/typedoc.config.mjs at main · THEOplayer/web-ui · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
/** @type {import('typedoc').TypeDocOptions} */
export default {
    entryPoints: ['src/index.ts'],
    out: 'api',
    hostedBaseUrl: 'https://theoplayer.github.io/web-ui/api/',
    readme: 'none',
    plugin: [
        'typedoc-plugin-external-resolver',
        'typedoc-plugin-mdn-links',
        import.meta.resolve('./scripts/typedoc-lit-decorators.mts'),
        import.meta.resolve('./scripts/typedoc-symbol-resolver.mts'),
        import.meta.resolve('./scripts/typedoc-collapsible-tags.mts')
    ],
    navigationLinks: {
        GitHub: 'https://github.com/THEOplayer/web-ui'
    },
    githubPages: true,
    excludePrivate: true,
    excludeInternal: true,
    excludeExternals: true,
    excludeTags: [
        '@nocollapse' // appears a lot in Lit docs
    ],
    externalDocumentation: {
        theoplayer: {
            dtsPath: '~/THEOplayer.d.ts',
            externalBaseURL: 'https://www.theoplayer.com/docs/theoplayer/v11/api-reference/web'
        }
    },
    externalSymbolLinkMappings: {
        'lit-element': {
            LitElement: 'https://lit.dev/docs/api/LitElement/',
            '*': 'https://lit.dev/docs/'
        },
        '@lit/reactive-element': {
            html: 'https://lit.dev/docs/api/templates/#html',
            TemplateResult: 'https://lit.dev/docs/api/templates/#TemplateResult',
            css: 'https://lit.dev/docs/api/styles/#css',
            CSSResult: 'https://lit.dev/docs/api/styles/#CSSResult',
            '*': 'https://lit.dev/docs/'
        }
    }
};