Skip to main content

How to install doxygen2docusaurus

GitHub package.json version NPM Version NPM Downloads NPM Downloads license

Prerequisites​

Installing doxygen2docusaurus requires:

  • A recent version of Node.js (specified as "engines.node": ">=20.0.0")
  • A recent version of npm which is installed alongside Node.js

For those new to Node.js, it is highly recommended to read the instructions on the xPack Prerequisites page.

Installation​

The package is available as @xpack/doxygen2docusaurus from the public npmjs repository; it may be added as a development dependency to any npm project or it may be installed into the user's global environment.

Project installation​

The command to install the latest available version of @xpack/doxygen2docusaurus as a development dependency in an npm project is:

npm install @xpack/doxygen2docusaurus@latest --save-dev

For a specific version, use the explicit version numbers:

npm install @xpack/doxygen2docusaurus@2.0.0 --save-dev

Global installation​

Since the package provides executables, it may also be installed globally and utilised in any project.

npm install --location=global @xpack/doxygen2docusaurus@latest

For a specific version, use the explicit version numbers:

npm install --location=global @xpack/doxygen2docusaurus@2.0.0

Uninstall​

The command to remove @xpack/doxygen2docusaurus from a project is:

npm uninstall @xpack/doxygen2docusaurus

The command to remove @xpack/doxygen2docusaurus from the global user environment is:

npm uninstall --location=global @xpack/doxygen2docusaurus

npx​

If, for any reason, you decide not to install @xpack/doxygen2docusaurus, you can still benefit from it by utilising the npx command, as a trampoline to start doxygen2docusaurus:

$ npx --package @xpack/doxygen2docusaurus -- doxygen2docusaurus --version
2.0.0

However, for regular use, this method may be less convenient, as invoking npx requires a more verbose command.

npm folders​

For more details on the folders used by npm, refer to npm-folders.