doctopus

doctopus

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

Build & Installation

Directly install:

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

Build from source using go build.

Building requires Go and GCC.

Build native current-platform binary with profile-guided optimization:

scripts/build-pgo.sh

Script generates platform-specific .pgo profile from BenchmarkWarmBuild, then builds native binary with go build -pgo and packs it into platform-specific .zip archive. Archive contains doctopus or doctopus.exe without platform suffix in archive entry name.

Build from macOS for macOS natively plus Linux GNU and Linux Musl with Docker:

scripts/build-from-macos.sh

Build from Windows natively in MSYS2:

scripts/build-from-windows.sh

Optional env vars:

ARTIFACT_DIR=./dist PGO_BENCHTIME=5s scripts/build-pgo.sh
DOCKER_PLATFORM=linux/amd64 scripts/build-from-macos.sh
GO_BUILD_TAGS=musl scripts/build-pgo.sh

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.