README.md

MkDoxy Demo

This is a demo of MkDoxy, a tool for generating Doxygen documentation from Markdown files.

👉 Look at JakubAndrysek / MkDoxy whole project. 👈

Demo of MkDoxy

Run demo locally

Tools

• python 3.6 or newer -> sudo apt install python3
• Pip -> sudo apt install python3-pip
• Git -> sudo apt install git
• Doxygen -> sudo apt install doxygen

PIP Packages

pip3 install -r requirements.txt

Usage

Serve MkDocs locally:

mkdocs serve

Build MkDocs:

mkdocs build