doctopus

doctopus

doctopus is a highly opinionated tool for generating a documentation website from markdown files.

Build & Installation

Prebuilt:

curl --proto '=https' --tlsv1.3 -sSf https://doctopus.frankmayer.dev/install.sh | sh

From source:

go install codeberg.org/tsukinoko-kun/doctopus@latest

or clone and

go install .

Use the build tag musl on Musl Linux. Without it, glibc will be linked.

Usage

Initialize with doctopus init, edit the doctopus.yaml file, run doctopus to generate the website.

You can spin up a local server using doctopus dev that re-builds the website on every change.