https://github.com/jakubandrysek/mkdoxy-demo

:blue_book: MkDoxy -> MkDocs + Doxygen. Easy documentation generator with code snippets.
https://github.com/jakubandrysek/mkdoxy-demo

md mkdocs mkdoxy python python3

Last synced: 3 days ago
JSON representation

:blue_book: MkDoxy -> MkDocs + Doxygen. Easy documentation generator with code snippets.

• Host: GitHub
• URL: https://github.com/jakubandrysek/mkdoxy-demo
• Owner: JakubAndrysek
• License: mit
• Created: 2023-01-24T20:01:00.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T10:03:24.000Z (7 months ago)
• Last Synced: 2024-12-18T03:11:44.875Z (22 days ago)
• Topics: md, mkdocs, mkdoxy, python, python3
• Language: C++
• Homepage: http://mkdoxy-demo.kubaandrysek.cz/
• Size: 2.56 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDoxy Demo









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

### 👉 Look at [JakubAndrysek / MkDoxy](https://github.com/JakubAndrysek/MkDoxy) whole project. 👈

### [Demo of MkDoxy](https://mkdoxy-demo.kubaandrysek.cz/)

## 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

```bash

pip3 install -r requirements.txt

```

## Usage

Serve MkDocs locally:

```bash

mkdocs serve

```

Build MkDocs:

```bash

mkdocs build

```