Doxygen Playground

Welcome to the Doxygen Playground! This repository is designed to experiment with Doxygen and Markdown-based documentation, with a focus on detecting bugs and testing documentation workflows.

🚀 Features

Write documentation in Markdown (.md) files
Automatic documentation generation with the latest Doxygen (via GitHub Actions)
Continuous deployment to GitHub Pages
Example usage and code snippets

📦 Getting Started

Clone this repository
git clone https://github.com/MangaD/Doxygen-Playground.git

cd Doxygen-Playground
Add or edit Markdown files
- Place your documentation in .md files (e.g., README.md, usage.md).
Generate documentation locally (optional)
- Make sure you have Doxygen installed.
- Run:
  doxygen Doxyfile
- The generated HTML will be in docs/html.
Push changes to GitHub
- Documentation will be built and published automatically by GitHub Actions.

🛠️ Usage Example

See usage.md for usage instructions and code examples.

See subdir/usage.md for the same usage instructions and code examples.

� Documentation Output

Local: After running Doxygen, open docs/html/index.html in your browser.
Online: The latest documentation is published at:

👉 https://mangad.github.io/Doxygen-Playground

🤖 About This Repository

Note: This repository is intended for experimenting with Doxygen in order to detect bugs and test documentation workflows. Feel free to open issues if you find any bugs or have suggestions!