MkDoxy Demo

March 25, 2023 ยท View on GitHub

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