Skip to content

docs: Document Doxygen main page heading requirement #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReenigneArcher merged 1 commit into from
Sep 3, 2026
Merged

docs: Document Doxygen main page heading requirement #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,20 @@
</div>

<div align="center">
<a href="https://sonarcloud.io/project/overview?id=LizardByte_doyxconfig"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_doxyconfig.svg?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
<a href="https://sonarcloud.io/project/overview?id=LizardByte_doxyconfig"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_doxyconfig.svg?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
</div>

## Usage
# Overview

This repository provides the common Doxygen configuration used by LizardByte projects. It includes shared Doxygen
defaults, Doxygen Awesome styling, custom aliases, and CMake and Read the Docs integration.

## 🚀 Usage

> [!IMPORTANT]
> When using a Markdown file with `USE_MDFILE_AS_MAINPAGE`, make its first Markdown heading a level 1 heading
> (`# ...`). An HTML `<h1>` does not count. Starting with a level 2 or lower Markdown heading can cause Doxygen to
> place the main page's sections beneath the next Markdown page in the navigation tree.

1. Add this repository as a submodule to your project.

Expand Down Expand Up @@ -43,7 +53,7 @@
INPUT += ../third-party/doxyconfig/docs/source_code.md
```

6. Optionally, copy the `.readthedocs.yaml` file to the root of your project.
6. To build the project on Read the Docs, copy `.readthedocs.yaml` to the root of your project.

<details style="display: none;">
<summary></summary>
Expand Down