APKDOC

Document generator for alpine’s index format v2 file^1.

Usage example

apkdoc \
	-t text \
	-u https://alpine.mirror.wearetriple.com/v3.18/main/x86_64/APKINDEX.tar.gz \
	-f example.md \
	-o index.txt

Data

apkdoc offers a list of the following struct to the template:

type Entry struct {
	Checksum         string     // C
	Version          string     // V
	Name             string     // P
	Architecture     *string    // A
	PackageSize      int        // S
	InstalledSize    int        // I
	Description      string     // T
	Url              string     // U
	License          string     // L
	Origin           *string    // o
	Maintainer       *string    // m
	BuildTime        *time.Time // t
	Commit           *string    // c
	ProviderPriority *int       // k
	Dependencies     []string   // D
	Provides         []string   // p
	InstallIf        []string   // i
}

Functions

apkdoc also offers a couple help functions.

DerefI

Deref int pointer.

DerefS

Deref string pointer.

Properties

A Entry function that generate a map of with lower cased space separated property name.