Skip to content

Commit d2c767b

Browse files
committed
website update
1 parent 8d7b25b commit d2c767b

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

website/docs/getting-started/_project/_overview.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{/* ------------------------------------------------------------------------ */}
22

3-
The **doxygen2docusaurus** project is a command-line tool that bridges the gap between Doxygen-generated API documentation and modern Docusaurus websites. It converts Doxygen XML output into CommonMark files optimised for Docusaurus, enabling seamless integration of comprehensive API reference documentation within your project's documentation site.
3+
[Doxygen](https://doxygen.nl) is the industry standard for generating API documentation from annotated C/C++ source code.
4+
5+
[Docusaurus](https://docusaurus.io) is a modern documentation website generator that provides a clean, responsive, and user-friendly interface for creating documentation sites.
6+
7+
**doxygen2docusaurus** is a command-line tool that bridges the gap between Doxygen-generated API documentation and modern Docusaurus websites. It converts Doxygen XML output into CommonMark files optimised for Docusaurus, enabling seamless integration of comprehensive API reference documentation within project documentation sites.
48

59
## Features & Benefits
610

@@ -16,9 +20,9 @@ To improve the user navigation experience, for each reference sub-site, the tool
1620

1721
![doxygen2docusaurus navigation](/assets/images/navigation.png)
1822

19-
### Customisable topic organisation
23+
### Flexible topic-based structure
2024

21-
The tool enables grouping of API reference documentation by topics, which can be customised to suit your project's requirements. This feature enhances the organisation of documentation, making it easier for users to locate relevant information. Each topic page is organised into clear sections, with comprehensive indices for all sections displayed at the beginning of the page for quick navigation.
25+
The tool enables grouping of API reference documentation by topics, which can be customised to suit project requirements. This feature enhances the organisation of documentation, making it easier for users to locate relevant information. Each topic page is organised into clear sections, with comprehensive indices for all sections displayed at the beginning of the page for quick navigation.
2226

2327
![doxygen2docusaurus topics](/assets/images/topics.png)
2428

0 commit comments

Comments
 (0)