You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Almost one year ago I discovered Docusaurus and since then I migrated most of my documentation sites to it. (for example: https://xpack-dev-tools.github.io, a set of 20+ projects).
The interesting part of this site is that it includes an API Reference section, generated with TypeDoc, and converted into Markdown with docusaurus-plugin-typedoc.
Since my main interest is C/C++, and I already successfully used your nice theme to document one of my projects (https://micro-os-plus.github.io/utils-lists-xpack/), I am started to think that perhaps similar solution to TypeScript would apply to C/C++ too, i.e. a Docusaurus Doxygen plugin (docusaurus-plugin-doxygen?).
The idea would be to use Doxygen to output XML, and convert it to Docusaurus markdown pages (actually React components).
For styles, your awesome CSSs would provide the nice look.
I do have some (limited) experience with Docusaurus internals and with TypeScript, thus I think I can start work on such a plugin, but my experience with CSS and Doxygen pages is poor, and here your help would be invaluable.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Hi @jothepro,
Almost one year ago I discovered Docusaurus and since then I migrated most of my documentation sites to it. (for example: https://xpack-dev-tools.github.io, a set of 20+ projects).
Recently, I also migrated some of my TypeScripts projects (for example https://xpack.github.io/logger-ts/).
The interesting part of this site is that it includes an API Reference section, generated with TypeDoc, and converted into Markdown with docusaurus-plugin-typedoc.
Compared with the initial solution (https://xpack.github.io/logger-ts-web-typedoc/) I would say that the result is much nicer.
Since my main interest is C/C++, and I already successfully used your nice theme to document one of my projects (https://micro-os-plus.github.io/utils-lists-xpack/), I am started to think that perhaps similar solution to TypeScript would apply to C/C++ too, i.e. a Docusaurus Doxygen plugin (
docusaurus-plugin-doxygen
?).The idea would be to use Doxygen to output XML, and convert it to Docusaurus markdown pages (actually React components).
For styles, your awesome CSSs would provide the nice look.
I do have some (limited) experience with Docusaurus internals and with TypeScript, thus I think I can start work on such a plugin, but my experience with CSS and Doxygen pages is poor, and here your help would be invaluable.
What do you think about such a project?
Beta Was this translation helpful? Give feedback.
All reactions