@xpack/doxygen2docusaurus 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Liviu Ionescu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,25 @@
+[![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/blob/master/package.json)
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/releases)
+[![NPM Version](https://img.shields.io/npm/v/@xpack/doxygen2docusaurus?color=blue)](https://www.npmjs.com/package/@xpack/doxygen2docusaurus/)
+[![license](https://img.shields.io/github/license/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/blob/master/LICENSE)
+
+# The doxygen2docusaurus
+
+A Node.js CLI application to convert Doxygen XML files into Docusaurus documentation.
+
+## Project documentation
+
+For information on how to install and use this project, please refer to the
+[project website](https://xpack.github.io/doxygen2docusaurus-cli-ts/).
+
+## Project source
+
+The source code of the current release is available on
+[GitHub tag v1.0.1 tree](https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v1.0.1).
+
+## License
+
+Unless otherwise stated, the original content is released under the terms of the
+[MIT License](https://opensource.org/licenses/mit),
+with all rights reserved to
+[Liviu Ionescu](https://github.com/ilg-ul).

package/bin/doxygen2docusaurus.js

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+// Mandatory shebang must point to `node` and this file must be executable.
+
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/license/mit.
+ */
+
+'use strict'
+
+/*
+ * On POSIX platforms, when installing a global package,
+ * a symbolic link named `doxygen2docusaurus` is created
+ * in the `/usr/local/bin` folder (on macOS), or
+ * in the `/usr/bin` folder (on Ubuntu), pointing to this file.
+ *
+ * On Windows, where symbolic links are not available,
+ * when installing a global package,
+ * two forwarders are automatically created in the
+ * user `\AppData\Roaming\npm\node_modules\doxygen2docusaurus\bin` folder:
+ * - `doxygen2docusaurus.cmd`, for invocation from the Windows command line
+ * - `doxygen2docusaurus` (a shell script), for invocations from an optional
+ * POSIX environments like minGW-w64, msys2, git shell, etc.
+ *
+ * On all platforms, `process.argv[1]` will be the full path of
+ * this file, or the full path of the `doxygen2docusaurus` link, so, in case
+ * the program will need to be invoked with different names,
+ * this is the method to differentiate between them.
+ */
+
+// ----------------------------------------------------------------------------
+
+import { main } from '../dist/cli/main.js'
+
+// ----------------------------------------------------------------------------
+
+process.exit(await main(process.argv))
+
+// ----------------------------------------------------------------------------

package/dist/cli/main.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Main entry point for the doxygen2docusaurus CLI tool.
+ *
+ * @param argv - Command line arguments array
+ * @returns Promise that resolves to the exit code (0 for success, 1 for error)
+ *
+ * @public
+ */
+export declare function main(argv: string[]): Promise<number>;
+//# sourceMappingURL=main.d.ts.map

package/dist/cli/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AA4BA;;;;;;;GAOG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAkD1D"}

package/dist/cli/main.js

@@ -0,0 +1,66 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT.
+ */
+// ----------------------------------------------------------------------------
+// import assert from 'node:assert'
+import * as path from 'node:path';
+import * as fs from 'node:fs/promises';
+// import * as util from 'node:util'
+// https://www.npmjs.com/package/commander
+import { CliOptions } from '../docusaurus/cli-options.js';
+import { formatDuration } from '../docusaurus/utils.js';
+import { DataModel } from '../doxygen/data-model/data-model.js';
+import { DocusaurusGenerator } from '../docusaurus/generator.js';
+import { Workspace } from '../docusaurus/workspace.js';
+import { fileURLToPath } from 'node:url';
+// ----------------------------------------------------------------------------
+/**
+ * Main entry point for the doxygen2docusaurus CLI tool.
+ *
+ * @param argv - Command line arguments array
+ * @returns Promise that resolves to the exit code (0 for success, 1 for error)
+ *
+ * @public
+ */
+export async function main(argv) {
+    const startTime = Date.now();
+    // Like .../doxygen2docusaurus/dist/cli
+    const __dirname = path.dirname(fileURLToPath(import.meta.url));
+    const packageJsonPath = path.join(path.dirname(path.dirname(__dirname)), 'package.json');
+    const packageJsonContent = await fs.readFile(packageJsonPath);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const packageJson = JSON.parse(packageJsonContent.toString());
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+    const packageVersion = packageJson.version;
+    let commandLine = path.basename(argv[1] ?? 'doxygen2docusaurus');
+    if (argv.length > 2) {
+        commandLine += ` ${argv.slice(2).join(' ')}`;
+    }
+    console.log(`Running '${commandLine}' (v${packageVersion})...`);
+    const options = new CliOptions(argv);
+    await options.parse();
+    let exitCode = 0;
+    console.log();
+    const dataModel = new DataModel(options);
+    await dataModel.parse();
+    dataModel.projectVersion = packageVersion;
+    const workspace = new Workspace(dataModel);
+    const generator = new DocusaurusGenerator(workspace);
+    exitCode = await generator.run();
+    const durationString = formatDuration(Date.now() - startTime);
+    if (exitCode === 0) {
+        console.log();
+        console.log(`Running '${commandLine}' has completed successfully ` +
+            `in ${durationString}.`);
+    }
+    return exitCode;
+}
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=main.js.map

package/dist/cli/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,oCAAoC;AAEpC,0CAA0C;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE5B,uCAAuC;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACrC,cAAc,CACf,CAAA;IACD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IAE7D,mEAAmE;IACnE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,+GAA+G;IAC/G,MAAM,cAAc,GAAW,WAAW,CAAC,OAAO,CAAA;IAElD,IAAI,WAAW,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAA;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,WAAW,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC9C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,YAAY,WAAW,OAAO,cAAc,MAAM,CAAC,CAAA;IAE/D,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IACpC,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IAErB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;IACvB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAA;IAEzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;IAE1C,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACpD,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAA;IAEhC,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;IAE7D,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,OAAO,CAAC,GAAG,CACT,YAAY,WAAW,+BAA+B;YACpD,MAAM,cAAc,GAAG,CAC1B,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,+EAA+E"}

package/dist/docusaurus/cli-options.d.ts

@@ -0,0 +1,98 @@
+export interface Redirects {
+    from: string | string[];
+    to: string;
+}
+/**
+ * Options, as written by the user. All are optional.
+ *
+ * @public
+ */
+export type CliConfigurationOptions = Record<string, string | boolean>;
+/**
+ * Options, when multi-configurations are used.
+ *
+ * @public
+ */
+export type MultiConfigurations = Record<string, CliConfigurationOptions>;
+/**
+ * Options, as seen by the application. Most are mandatory.
+ *
+ * @public
+ */
+export declare class CliOptions {
+    /**
+     * Relative to the current website folder, like `doxygen/xml`, no initial/
+     * final slashes.
+     */
+    doxygenXmlInputFolderPath: string;
+    /**
+     * Relative to the current website folder, like `docs`, no initial/final
+     * slashes.
+     */
+    docsFolderPath: string;
+    /** Relative to the docs folder, like `api`, no initial/final slashes. */
+    apiFolderPath: string;
+    /** Site base URL, like / or /xxx/. */
+    baseUrl: string;
+    /** Relative to the web home, like `docs`, without initial/final slashes. */
+    docsBaseUrl: string;
+    /** Relative to the docs home, like `api`, without initial/final slashes. */
+    apiBaseUrl: string;
+    /** Relative to `static` */
+    imagesFolderPath: string;
+    /**  Relative to the current `website/static` folder, like `reference`. */
+    compatibilityRedirectsOutputFolderPath?: string | undefined;
+    /** The title to be displayed on the main page. */
+    mainPageTitle: string;
+    /**
+     * Relative to the current website folder, default
+     * `sidebar-category-doxygen.json`.
+     */
+    sidebarCategoryFilePath: string;
+    /** Short text to be displayed in the sidebar. */
+    sidebarCategoryLabel: string;
+    /**
+     * Relative to the current website folder, default
+     * `docusaurus-config-doxygen-menu-dropdown.json`.
+     */
+    menuDropdownFilePath: string;
+    /** Short text to be displayed in the menu. */
+    menuDropdownLabel: string;
+    /**
+     * Relative to the current website folder, default
+     * `src/css/custom-doxygen.css`
+     */
+    customCssFilePath: string;
+    /** Boolean to control verbosity. */
+    verbose: boolean;
+    /** Boolean to control debug verbosity. */
+    debug: boolean;
+    /** Boolean to control if the TODO suggestions are shown. */
+    suggestToDoDescriptions: boolean;
+    /** Boolean to render the pages to the top. */
+    renderPagesAtTop: boolean;
+    /** Boolean to render the program listing in the File pages. */
+    renderProgramListing: boolean;
+    /**
+     * Boolean to render the program listing in the member definitions sections.
+     */
+    renderProgramListingInline: boolean;
+    /**
+     * Location of original Doxygen pages
+     *
+     * 'For comparison, the original Doxygen html pages, styled with the
+     * <a href="https://jothepro.github.io/doxygen-awesome-css/">doxygen-awesome-css</a>
+     * plugin, continue to be available via the
+     * <a href="pathname:///doxygen/topics.html"><code>.../doxygen/*.html</b></code>
+     * URLs.'
+     */
+    originalPagesNote: string;
+    /** String identifier in case of multiple instances. */
+    id: string;
+    constructor(argv: string[]);
+    parse(): Promise<void>;
+    selectMultiConfiguration(multiConfigurations: CliConfigurationOptions | MultiConfigurations): CliConfigurationOptions | undefined;
+}
+export declare const renderParagraphs = true;
+export declare const maxParallelPromises = 42;
+//# sourceMappingURL=cli-options.d.ts.map

package/dist/docusaurus/cli-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-options.d.ts","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAuBA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAEtE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AAQzE;;;;GAIG;AACH,qBAAa,UAAU;IACrB;;;OAGG;IACH,yBAAyB,SAAgB;IAEzC;;;OAGG;IACH,cAAc,SAAS;IAEvB,yEAAyE;IACzE,aAAa,SAAQ;IAErB,sCAAsC;IACtC,OAAO,SAAM;IAEb,4EAA4E;IAC5E,WAAW,SAAS;IAEpB,4EAA4E;IAC5E,UAAU,SAAQ;IAElB,2BAA2B;IAC3B,gBAAgB,SAAgB;IAEhC,0EAA0E;IAC1E,sCAAsC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3D,kDAAkD;IAClD,aAAa,SAAK;IAElB;;;OAGG;IACH,uBAAuB,SAAkC;IAEzD,iDAAiD;IACjD,oBAAoB,SAA4B;IAEhD;;;OAGG;IACH,oBAAoB,SAAwC;IAE5D,8CAA8C;IAC9C,iBAAiB,SAAc;IAE/B;;;OAGG;IACH,iBAAiB,SAA0C;IAE3D,oCAAoC;IACpC,OAAO,UAAQ;IAEf,0CAA0C;IAC1C,KAAK,UAAQ;IAEb,4DAA4D;IAC5D,uBAAuB,UAAQ;IAE/B,8CAA8C;IAC9C,gBAAgB,UAAO;IAEvB,+DAA+D;IAC/D,oBAAoB,UAAO;IAE3B;;OAEG;IACH,0BAA0B,UAAO;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,SAAK;IAEtB,uDAAuD;IACvD,EAAE,SAAY;gBAEF,IAAI,EAAE,MAAM,EAAE;IA2BpB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+G5B,wBAAwB,CACtB,mBAAmB,EAAE,uBAAuB,GAAG,mBAAmB,GACjE,uBAAuB,GAAG,SAAS;CAkBvC;AAGD,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAEpC,eAAO,MAAM,mBAAmB,KAAK,CAAA"}

package/dist/docusaurus/cli-options.js

@@ -0,0 +1,212 @@
+/*
+ * This file is part of the xPack project (http://xpack.github.io).
+ * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
+ *
+ * Permission to use, copy, modify, and/or distribute this software
+ * for any purpose is hereby granted, under the terms of the MIT license.
+ *
+ * If a copy of the license was not distributed with this file, it can
+ * be obtained from https://opensource.org/licenses/MIT.
+ */
+// ----------------------------------------------------------------------------
+import assert from 'node:assert';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+// import * as util from 'node:util'
+// https://www.npmjs.com/package/commander
+import { Command } from 'commander';
+/**
+ * Options, as seen by the application. Most are mandatory.
+ *
+ * @public
+ */
+export class CliOptions {
+    /**
+     * Relative to the current website folder, like `doxygen/xml`, no initial/
+     * final slashes.
+     */
+    doxygenXmlInputFolderPath = 'doxygen/xml';
+    /**
+     * Relative to the current website folder, like `docs`, no initial/final
+     * slashes.
+     */
+    docsFolderPath = 'docs';
+    /** Relative to the docs folder, like `api`, no initial/final slashes. */
+    apiFolderPath = 'api';
+    /** Site base URL, like / or /xxx/. */
+    baseUrl = '/';
+    /** Relative to the web home, like `docs`, without initial/final slashes. */
+    docsBaseUrl = 'docs';
+    /** Relative to the docs home, like `api`, without initial/final slashes. */
+    apiBaseUrl = 'api';
+    /** Relative to `static` */
+    imagesFolderPath = 'img/doxygen';
+    /**  Relative to the current `website/static` folder, like `reference`. */
+    compatibilityRedirectsOutputFolderPath;
+    /** The title to be displayed on the main page. */
+    mainPageTitle = '';
+    /**
+     * Relative to the current website folder, default
+     * `sidebar-category-doxygen.json`.
+     */
+    sidebarCategoryFilePath = 'sidebar-category-doxygen.json';
+    /** Short text to be displayed in the sidebar. */
+    sidebarCategoryLabel = 'API Reference (Doxygen)';
+    /**
+     * Relative to the current website folder, default
+     * `docusaurus-config-doxygen-menu-dropdown.json`.
+     */
+    menuDropdownFilePath = 'docusaurus-config-menu-doxygen.json';
+    /** Short text to be displayed in the menu. */
+    menuDropdownLabel = 'Reference';
+    /**
+     * Relative to the current website folder, default
+     * `src/css/custom-doxygen.css`
+     */
+    customCssFilePath = 'src/css/custom-doxygen2docusaurus.css';
+    /** Boolean to control verbosity. */
+    verbose = false;
+    /** Boolean to control debug verbosity. */
+    debug = false;
+    /** Boolean to control if the TODO suggestions are shown. */
+    suggestToDoDescriptions = false;
+    /** Boolean to render the pages to the top. */
+    renderPagesAtTop = true;
+    /** Boolean to render the program listing in the File pages. */
+    renderProgramListing = true;
+    /**
+     * Boolean to render the program listing in the member definitions sections.
+     */
+    renderProgramListingInline = true;
+    /**
+     * Location of original Doxygen pages
+     *
+     * 'For comparison, the original Doxygen html pages, styled with the
+     * <a href="https://jothepro.github.io/doxygen-awesome-css/">doxygen-awesome-css</a>
+     * plugin, continue to be available via the
+     * <a href="pathname:///doxygen/topics.html"><code>.../doxygen/*.html</b></code>
+     * URLs.'
+     */
+    originalPagesNote = '';
+    /** String identifier in case of multiple instances. */
+    id = 'default';
+    constructor(argv) {
+        const program = new Command();
+        program.option('--id <name>', 'id, for multi-configurations');
+        program.parse(argv);
+        const programOptions = program.opts();
+        this.id = programOptions.id ?? 'default';
+        if (this.id !== 'default') {
+            this.apiFolderPath = this.id;
+            this.apiBaseUrl = this.id;
+            this.imagesFolderPath = `img/doxygen-${this.id}`;
+            this.sidebarCategoryFilePath =
+                'sidebar-category-doxygen' + `-${this.id}.json`;
+            this.menuDropdownFilePath =
+                'docusaurus-config-navbar-doxygen' + `-${this.id}.json`;
+        }
+        else {
+            this.apiFolderPath = 'api';
+            this.apiBaseUrl = 'api';
+            this.imagesFolderPath = `img/doxygen`;
+            this.sidebarCategoryFilePath = `sidebar-category-doxygen.json`;
+            this.menuDropdownFilePath = `docusaurus-config-navbar-doxygen.json`;
+        }
+    }
+    async parse() {
+        let configurationOptions = undefined;
+        try {
+            const userPackageJsonPath = path.resolve(process.cwd(), 'config', 'doxygen2docusaurus.json');
+            const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            const multiConfigurations = JSON.parse(pkgJsonRaw);
+            configurationOptions = this.selectMultiConfiguration(multiConfigurations);
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        }
+        catch (err) {
+            /* Cannot read/parse JSON */
+        }
+        if (configurationOptions === undefined) {
+            try {
+                const userPackageJsonPath = path.resolve(process.cwd(), 'doxygen2docusaurus.json');
+                const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                const multiConfigurations = JSON.parse(pkgJsonRaw);
+                configurationOptions =
+                    this.selectMultiConfiguration(multiConfigurations);
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            }
+            catch (err) {
+                /* Cannot read/parse JSON */
+            }
+        }
+        if (configurationOptions === undefined) {
+            try {
+                // Try to get the configuration from
+                // package.json/[config/]doxygen2docusaurus.
+                const userPackageJsonPath = path.resolve(process.cwd(), 'package.json');
+                const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                const pkgJson = JSON.parse(pkgJsonRaw);
+                const multiConfigurations = pkgJson.config?.doxygen2docusaurus ?? pkgJson.doxygen2docusaurus;
+                if (multiConfigurations !== undefined) {
+                    configurationOptions =
+                        this.selectMultiConfiguration(multiConfigurations);
+                }
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            }
+            catch (err) {
+                /* Cannot read/parse JSON */
+            }
+        }
+        if (this.debug) {
+            console.log(configurationOptions);
+        }
+        if (configurationOptions !== undefined) {
+            // Override only properties that exist in CliOptions
+            const thisProperties = Object.getOwnPropertyNames(this);
+            for (const key of Object.keys(configurationOptions)) {
+                const value = configurationOptions[key];
+                // console.log(key, value)
+                if (value !== undefined && thisProperties.includes(key)) {
+                    const thisProperty = this[key];
+                    const thisType = typeof thisProperty;
+                    const valueType = typeof value;
+                    // Only override if types match
+                    if (thisType === valueType) {
+                        ;
+                        this[key] = value;
+                    }
+                }
+            }
+        }
+        if (this.verbose) {
+            console.log();
+            console.log(this);
+        }
+        assert(this.doxygenXmlInputFolderPath.length > 0, 'doxygenXmlInputFolderPath is required');
+        assert(this.docsFolderPath.length > 0, 'docsFolderPath is required');
+        assert(this.apiFolderPath.length > 0, 'apiFolderPath is required');
+        assert(this.docsBaseUrl.length > 0, 'docsBaseUrl is required');
+        // assert(this.apiBaseUrl.length > 0, 'apiBaseUrl is required')
+        assert(this.sidebarCategoryFilePath.length > 0, 'sidebarCategoryFilePath is required');
+    }
+    selectMultiConfiguration(multiConfigurations) {
+        let configurationOptions = undefined;
+        if (this.id !== 'default') {
+            configurationOptions = multiConfigurations[this.id];
+            if (configurationOptions !== undefined) {
+                configurationOptions.id = this.id;
+            }
+        }
+        else {
+            configurationOptions = multiConfigurations;
+        }
+        return configurationOptions;
+    }
+}
+// Was used during development. Now stick to true.
+export const renderParagraphs = true;
+export const maxParallelPromises = 42;
+// ----------------------------------------------------------------------------
+//# sourceMappingURL=cli-options.js.map

package/dist/docusaurus/cli-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli-options.js","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,oCAAoC;AAEpC,0CAA0C;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AA6BnC;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACrB;;;OAGG;IACH,yBAAyB,GAAG,aAAa,CAAA;IAEzC;;;OAGG;IACH,cAAc,GAAG,MAAM,CAAA;IAEvB,yEAAyE;IACzE,aAAa,GAAG,KAAK,CAAA;IAErB,sCAAsC;IACtC,OAAO,GAAG,GAAG,CAAA;IAEb,4EAA4E;IAC5E,WAAW,GAAG,MAAM,CAAA;IAEpB,4EAA4E;IAC5E,UAAU,GAAG,KAAK,CAAA;IAElB,2BAA2B;IAC3B,gBAAgB,GAAG,aAAa,CAAA;IAEhC,0EAA0E;IAC1E,sCAAsC,CAAqB;IAE3D,kDAAkD;IAClD,aAAa,GAAG,EAAE,CAAA;IAElB;;;OAGG;IACH,uBAAuB,GAAG,+BAA+B,CAAA;IAEzD,iDAAiD;IACjD,oBAAoB,GAAG,yBAAyB,CAAA;IAEhD;;;OAGG;IACH,oBAAoB,GAAG,qCAAqC,CAAA;IAE5D,8CAA8C;IAC9C,iBAAiB,GAAG,WAAW,CAAA;IAE/B;;;OAGG;IACH,iBAAiB,GAAG,uCAAuC,CAAA;IAE3D,oCAAoC;IACpC,OAAO,GAAG,KAAK,CAAA;IAEf,0CAA0C;IAC1C,KAAK,GAAG,KAAK,CAAA;IAEb,4DAA4D;IAC5D,uBAAuB,GAAG,KAAK,CAAA;IAE/B,8CAA8C;IAC9C,gBAAgB,GAAG,IAAI,CAAA;IAEvB,+DAA+D;IAC/D,oBAAoB,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,0BAA0B,GAAG,IAAI,CAAA;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,GAAG,EAAE,CAAA;IAEtB,uDAAuD;IACvD,EAAE,GAAG,SAAS,CAAA;IAEd,YAAY,IAAc;QACxB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;QAE7B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,8BAA8B,CAAC,CAAA;QAC7D,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAEnB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;QAErC,IAAI,CAAC,EAAE,GAAI,cAAc,CAAC,EAAyB,IAAI,SAAS,CAAA;QAEhE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAA;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;YACzB,IAAI,CAAC,gBAAgB,GAAG,eAAe,IAAI,CAAC,EAAE,EAAE,CAAA;YAChD,IAAI,CAAC,uBAAuB;gBAC1B,0BAA0B,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;YACjD,IAAI,CAAC,oBAAoB;gBACvB,kCAAkC,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;YACrC,IAAI,CAAC,uBAAuB,GAAG,+BAA+B,CAAA;YAC9D,IAAI,CAAC,oBAAoB,GAAG,uCAAuC,CAAA;QACrE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QAEzE,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;YAEjE,mEAAmE;YACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAEvE,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;YACzE,6DAA6D;QAC/D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,4BAA4B;QAC9B,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,yBAAyB,CAC1B,CAAA;gBACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEvE,oBAAoB;oBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACpD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,oCAAoC;gBACpC,4CAA4C;gBAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;gBACvE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,OAAO,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEnE,MAAM,mBAAmB,GAIvB,OAAO,CAAC,MAAM,EAAE,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAA;gBAElE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,oBAAoB;wBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACtD,CAAC;gBACD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,oDAAoD;YACpD,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAY,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBAChD,0BAA0B;gBAC1B,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAA;oBAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAA;oBACpC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAA;oBAE9B,+BAA+B;oBAC/B,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,CAAC;wBAAC,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,MAAM,CACJ,IAAI,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EACzC,uCAAuC,CACxC,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACpE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAElE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAA;QAC9D,+DAA+D;QAE/D,MAAM,CACJ,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EACvC,qCAAqC,CACtC,CAAA;IACH,CAAC;IAED,wBAAwB,CACtB,mBAAkE;QAElE,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QACzE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,oBAAoB,GAClB,mBAID,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEV,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,oBAAoB,GAAG,mBAA8C,CAAA;QACvE,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAED,kDAAkD;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAEpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAErC,+EAA+E"}

package/dist/docusaurus/generator.d.ts

@@ -0,0 +1,22 @@
+import { Workspace } from './workspace.js';
+import { CliOptions } from './cli-options.js';
+import type { CompoundBase } from './view-model/compound-base-vm.js';
+export declare class DocusaurusGenerator {
+    workspace: Workspace;
+    options: CliOptions;
+    constructor(workspace: Workspace);
+    run(): Promise<number>;
+    prepareOutputFolder(): Promise<void>;
+    generateSidebarFile(): Promise<void>;
+    generateMenuFile(): Promise<void>;
+    generateCollectionsIndexDotMdFiles(): Promise<void>;
+    generateTopIndexDotMdFile(): Promise<void>;
+    generatePerInitialsIndexMdFiles(): Promise<void>;
+    generatePages(): Promise<void>;
+    generatePage(compound: CompoundBase): Promise<void>;
+    generateCompatibilityRedirectFiles(): Promise<void>;
+    private generateRedirectFile;
+    copyFiles(): Promise<void>;
+    copyImageFiles(): Promise<void>;
+}
+//# sourceMappingURL=generator.d.ts.map

package/dist/docusaurus/generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/docusaurus/generator.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAMlE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAKpE,qBAAa,mBAAmB;IAC9B,SAAS,EAAE,SAAS,CAAA;IAEpB,OAAO,EAAE,UAAU,CAAA;gBAIP,SAAS,EAAE,SAAS;IAQ1B,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAuCtB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBpC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA4CpC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyDjC,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAYnD,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2E1C,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;IAYhD,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA+C9B,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;YA4G3C,oBAAoB;IAuC5B,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAyC1B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA0CtC"}