|
1 | 1 | {/* ------------------------------------------------------------------------ */} |
2 | 2 |
|
3 | | -[Doxygen](https://doxygen.nl) is the industry standard for generating API documentation from annotated C/C++ source code. |
| 3 | +[Doxygen](https://doxygen.nl) is the **industry standard** for generating API documentation from annotated **C/C++** source code. |
4 | 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. |
| 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 | 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. |
| 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. |
8 | 8 |
|
9 | 9 | ## Features & Benefits |
10 | 10 |
|
11 | 11 | ### High quality documentation pages |
12 | 12 |
|
13 | | -The tool leverages Docusaurus's clean, modern interface to create visually appealing and professional-looking documentation pages. |
| 13 | +The tool leverages Docusaurus's **clean**, **modern interface** to create visually appealing and **professional-looking documentation pages**. |
14 | 14 |
|
15 | 15 |  |
16 | 16 |
|
17 | 17 | ### Enhanced navigation experience |
18 | 18 |
|
19 | | -To improve the user navigation experience, for each reference sub-site, the tool generates a dropdown menu for the top navigation bar and a sidebar. For each page, it also creates the headers necessary for the table of contents. |
| 19 | +To improve the user navigation experience, for each reference sub-site, the tool generates a **dropdown menu** for the top navigation bar and a **sidebar**. For each page, it also creates the headers necessary for the **table of contents**. |
20 | 20 |
|
21 | 21 |  |
22 | 22 |
|
23 | 23 | ### Flexible topic-based structure |
24 | 24 |
|
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. |
| 25 | +Doxygen enables **grouping of API reference documentation by topics**, and **doxygen2docusaurus** prioritises rendering these topic pages with enhanced structural organisation. This functionality improves documentation accessibility, facilitating efficient information retrieval. Each topic page is systematically organised into distinct sections, with comprehensive indices presented at the beginning of each page to enable rapid navigation. |
26 | 26 |
|
27 | 27 |  |
28 | 28 |
|
29 | 29 | ### Streamlined documentation workflow |
30 | 30 |
|
31 | 31 | **doxygen2docusaurus** is a versatile CLI application that can be employed in virtually any scenario, from manual invocation to automated CI/CD environments, with the generated pages either forming part of the repository or being created dynamically during website publishing. |
32 | 32 |
|
33 | | -However, the recommended approach is to execute the tool on the development machine where the website is maintained, allowing the resulting CommonMark files to be seamlessly integrated into existing Docusaurus sites and stored within the project repository. |
| 33 | +However, the recommended approach is to **execute the tool on the development machine** where the website is maintained, allowing the resulting CommonMark files to be seamlessly integrated into existing Docusaurus sites and **stored within the project repository**. |
34 | 34 |
|
35 | 35 | Whilst this approach requires additional repository space, the significant advantage lies in enabling straightforward tracking of documentation changes. |
36 | 36 |
|
0 commit comments