Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Latest commit

 

History

History
37 lines (26 loc) · 792 Bytes

README.md

File metadata and controls

37 lines (26 loc) · 792 Bytes
Raw

kslibdocs

Generate a reference docs website for ksonnet-lib

Installation

This is an early version of kslibdocs. To use it, you build it from source:

$ mkdir -p ${GOPATH}/src/github.com/ksonnet
$ cd ${GOPATH}/src/github.com/ksonnet
$ git clone https://github.com/ksonnet/kslibdocs
$ go install github.com/ksonnet/kslibdocs/cmd/kslibdocgen

Usage

Build reference website HTML

$ kslibdocgen --k8sLib=/path/to/k8s.libsonnet -outDir=/tmp/build

Hack on HTML templates

$ hack/init-template.sh /tmp/custom-template
$ <...> hack on the template
$ kslibdocgen --k8sLib=/path/to/k8s.libsonnet -outDir=/tmp/build --templateDir=/tmp/custom-template

Update embedded template

$ hack/update-template.sh /tmp/custom-template
$ go generate ./pkg/...