From 1e8ab89ca299351879169a79d2627fe3a356ce4a Mon Sep 17 00:00:00 2001 From: Vitaly Puzrin Date: Thu, 13 Aug 2026 03:19:58 +0300 Subject: [PATCH] doc: add changelog to menu --- typedoc.config.mjs | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/typedoc.config.mjs b/typedoc.config.mjs index e879250..bd4ccb9 100644 --- a/typedoc.config.mjs +++ b/typedoc.config.mjs @@ -1,5 +1,15 @@ +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'], @@ -11,12 +21,14 @@ export default { 'docs/development.md', 'docs/benchmark.md', 'docs/authors.md', - 'docs/references.md' + 'docs/references.md', + 'CHANGELOG.md' ], alwaysCreateEntryPointModule: false, plugin: [ 'typedoc-plugin-missing-exports', + changelogPlugin, condensedThemePlugin ], theme: 'condensed',