Browse Source

doc: add changelog to menu

pull/1200/head
Vitaly Puzrin 2 months ago
parent
commit
1e8ab89ca2
  1. 14
      typedoc.config.mjs

14
typedoc.config.mjs

@ -1,5 +1,15 @@
import { Converter } from 'typedoc'
import condensedThemePlugin from './support/typedoc_condensed_theme/condensed_theme_plugin.mjs' 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 { export default {
entryPoints: ['src/index.ts'], entryPoints: ['src/index.ts'],
@ -11,12 +21,14 @@ export default {
'docs/development.md', 'docs/development.md',
'docs/benchmark.md', 'docs/benchmark.md',
'docs/authors.md', 'docs/authors.md',
'docs/references.md' 'docs/references.md',
'CHANGELOG.md'
], ],
alwaysCreateEntryPointModule: false, alwaysCreateEntryPointModule: false,
plugin: [ plugin: [
'typedoc-plugin-missing-exports', 'typedoc-plugin-missing-exports',
changelogPlugin,
condensedThemePlugin condensedThemePlugin
], ],
theme: 'condensed', theme: 'condensed',

Loading…
Cancel
Save