Website for carvel.dev

Local Development

Prerequisites

• Install Hugo
  • (Note "hugo extended" is required since this site uses SCSS)
  • Prebuilt binaries: https://github.com/gohugoio/hugo/releases
  • macOS: brew install hugo
  • Windows: choco install hugo-extended -confirm

Run locally

./hack/run.sh

Serve

Serve site at http://localhost:1313

Directories

• /themes/carvel/assets/ includes SCSS
• /themes/carvel/static/img/ includes images
• /content/ includes content for tool docs
• /data/ includes configuration for docs TOCs

More details: Directory Structure Explained

Generate documentation for new version

When creating a new version v0.1.0 of imgpkg

./hack/release-docs.sh imgpkg v0.1.0

Generate documentation for new patch

When creating a patch v0.1.1 for the version v0.1.0 of imgpkg

./hack/release-docs.sh imgpkg v0.1.1 v0.1.0