Skip to content

A Docusaurus plugin to integrate the Doxygen reference pages

License

Notifications You must be signed in to change notification settings

xpack/docusaurus-plugin-doxygen

Repository files navigation

docusaurus-plugin-doxygen

A Docusaurus plugin to integrate the Doxygen reference pages into Docusaurus documentation sites.

The reference pages will be generated under /docs/api/, similarly to the pages generated by docusaurus-plugin-typedoc

Note

Work in progress!


To install in the project website folder:

npm install @xpack/docusaurus-plugin-doxygen --save-dev -C website
``

or, during development:

```sh
(cd website; npm link @xpack/docusaurus-plugin-doxygen)

Add the plugin to docusaurus.config.js

module.exports = {
  // Add option types
  plugins: [
    [
      '@xpack/docusaurus-plugin-doxygen',

      // Options
      {
        doxygenXmlInputFolderPath: 'doxygen/xml',
        outputFolderPath: 'docs/api',
        sidebarFileName: 'sidebar-doxygen.ts'
      },
    ],
  ],
};

About

A Docusaurus plugin to integrate the Doxygen reference pages

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published