Doxide

Getting Started

Doxide is open source software distributed under an Apache 2.0 license. It runs on Linux, Mac, and Windows.

Install on Linux

Install a package for Ubuntu, Debian, Fedora, or openSUSE. A community-maintained package is also available for Arch Linux.

Alternatively, if using Homebrew, install with:

brew tap lawmurray/all
brew trust lawmurray/all
brew install doxide

Install on Mac

Install Homebrew if not already, then:

brew tap lawmurray/all
brew trust lawmurray/all
brew install doxide

Install on Windows

Install via your preferred means:

Installer

Download (Checksum)

Standalone program

Download (Checksum)

Put the program somewhere on your PATH environment variable, so that you can access it from a terminal.

Chocolatey

Install Chocolatey if not already, then:

choco install doxide

Windows Subsystem for Linux

You can use Windows Subsystem for Linux and follow the instructions for Linux.

Alternatively, build it from source yourself from the GitHub repository.

Install a static site generator

Doxide produces Markdown. You can use a static site generator to further convert that to HTML for display through a web browser. MkDocs and Material for MkDocs are recommended. To use them, you will need a working Python installation. Then, install with:

pip install mkdocs mkdocs-material mkdocs-material[imaging]

To manage MkDocs and other Python dependencies per project rather than system wide, you may like to use a Python virtual environment. Create it in your project directory:

python3 -m venv venv

Then enter it:

source venv/bin/activate

You can then run the above command to install MkDocs and Material for MkDocs into this virtual environment. When finished using the virtual environment, exit with:

deactivate