Repository navigation
Expand file tree
/
Copy pathtypedoc.config.mjs
More file actions
56 lines (50 loc) · 1.57 KB
/
Copy pathtypedoc.config.mjs
File metadata and controls
56 lines (50 loc) · 1.57 KB
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
44
45
46
47
48
49
50
51
52
53
54
55
56
import { Converter } from 'typedoc'
import condensedThemePlugin from './support/typedoc_condensed_theme/condensed_theme_plugin.mjs'
// Places CHANGELOG.md in Documents without adding TypeDoc frontmatter to it.
function changelogPlugin (app) {
app.converter.on(Converter.EVENT_CREATE_DOCUMENT, (_context, document) => {
if (document.name !== 'CHANGELOG') return
document.frontmatter.category = 'Documents'
})
}
export default {
entryPoints: ['src/index.ts'],
projectDocuments: [
'docs/usage.md',
'docs/syntax_plugins.md',
'docs/safety.md',
'docs/architecture.md',
'docs/development.md',
'docs/benchmark.md',
'docs/authors.md',
'docs/references.md',
'CHANGELOG.md'
],
alwaysCreateEntryPointModule: false,
plugin: [
'typedoc-plugin-missing-exports',
changelogPlugin,
condensedThemePlugin
],
theme: 'condensed',
excludeExternals: true,
excludeInternal: true,
placeInternalsInOwningModule: true,
out: 'apidoc',
includeVersion: true,
// `markdownLinkExternal` compares links against `hostedBaseUrl`,
// and does nothing until that one is set.
hostedBaseUrl: 'https://markdown-it.github.io/markdown-it/',
markdownLinkExternal: true,
sourceLinkExternal: true,
sourceLinkTemplate: 'https://github.com/markdown-it/markdown-it/blob/{gitRevision:short}/{path}#L{line}',
navigationLinks: {
GitHub: 'https://github.com/markdown-it/markdown-it'
},
defaultCategory: 'Plugin API',
categoryOrder: ['Main', 'Documents', 'Plugin API', '*'],
sort: ['source-order'],
navigation: {
includeCategories: true
}
}