quarks-docs

This repository holds the Quarks components docs.

The master branch holds the sources that are compiled with Hugo.

The website content it is deployed automatically in the gh-pages branch by Github Actions, and no manual intevention is needed.

Test your changes

After cloning the repo (with submodules), just run make website-serve to test the website locally.

$> git clone --recurse-submodule https://github.com/cloudfoundry-incubator/quarks-docs
$> cd quarks-docs
$> make serve

Or just sync the submodules:

$> git submodule update --init --recursive --depth 1

To run the website locally in other platforms, e.g. MacOS:

$> HUGO_PLATFORM=macOS-64bit make serve

Generate CLI docs

To automatically generate the CLI docs for the latest version of the Quarks components:

$> make gen-command-docs