CliOptions class

Comprehensive CLI options class for documentation generation configuration.

Signature

export declare class CliOptions

Remarks

The CliOptions class contains all configuration parameters that control the behaviour of the doxygen2docusaurus conversion process, including paths, URLs, styling, and feature toggles.

Constructors

Constructor	Modifiers	Description
(constructor)(commandOptions)		Creates a new CliOptions instance with the specified command options.

Properties

Property	Modifiers	Type	Description
apiBaseUrl		string	URL path to the API documentation relative to the docs section.
apiFolderPath		string	Path to the API documentation folder relative to the docs folder.
baseUrl		string	Base URL for the entire website.
compatibilityRedirectsOutputFolderPath?		string | undefined	(Optional) Output folder for compatibility redirect files.
customCssFilePath		string	Path to the custom CSS file for styling overrides.
debug		boolean	Controls debug-level output during the conversion process.
docsBaseUrl		string	URL path to the documentation section relative to the website root.
docsFolderPath		string	Path to the documentation folder relative to the website folder.
doxygenXmlInputFolderPath		string	Path to the Doxygen XML input folder relative to the website folder.
id		string	String identifier for distinguishing multiple configuration instances.
imagesFolderPath		string	Path for images relative to the static folder.
listPagesAtTop		boolean	Controls whether pages are listed at the top of the sidebar.
mainPageTitle		string	Title displayed on the main API documentation page.
navbarFilePath		string	Path to the navbar configuration file.
navbarLabel		string	Label displayed in the top navigation bar.
navbarPosition		'left' | 'right'	Position of the navigation menu in the top bar.
originalPagesNote		string	Note about the location of original Doxygen pages.
renderProgramListing		boolean	Controls program listing rendering in File pages.
renderProgramListingInline		boolean	Controls program listing rendering in member definition sections.
sidebarCategoryFilePath		string	Path to the sidebar category configuration file.
sidebarCategoryLabel		string	Label displayed in the Docusaurus sidebar for the API documentation.
suggestToDoDescriptions		boolean	Controls whether TODO suggestion descriptions are displayed.
verbose		boolean	Controls verbose output during the conversion process.

Methods

Method	Modifiers	Description
parse()		Parses configuration options from various JSON configuration sources.
selectMultiConfiguration(multiConfigurations)		Selects the appropriate configuration from multi-configuration options.

---

Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.