diff --git a/scripts/cmd_docs.sh b/scripts/cmd_docs.sh index e942e46..21c3535 100755 --- a/scripts/cmd_docs.sh +++ b/scripts/cmd_docs.sh @@ -6,10 +6,8 @@ if which gsed >/dev/null 2>&1; then SED="gsed" fi +mkdir -p www/docs/cmd rm -rf www/docs/cmd/*.md - -git checkout -- go.* -go mod tidy go run ./cmd/nfpm docs go run ./cmd/nfpm schema -o ./www/docs/static/schema.json diff --git a/www/docs/cmd/nfpm.md b/www/docs/cmd/nfpm.md index 4e39eb9..9ba1b9c 100644 --- a/www/docs/cmd/nfpm.md +++ b/www/docs/cmd/nfpm.md @@ -1,6 +1,6 @@ # nfpm -packages apps on RPM, Deb and APK formats based on a YAML configuration file +Packages apps on RPM, Deb and APK formats based on a YAML configuration file ## Synopsis @@ -15,7 +15,7 @@ nFPM is a simple, 0-dependencies, deb, rpm and apk packager. ## See also * [nfpm completion](/cmd/nfpm_completion/) - Generate the autocompletion script for the specified shell -* [nfpm init](/cmd/nfpm_init/) - creates a sample nfpm.yaml config file -* [nfpm jsonschema](/cmd/nfpm_jsonschema/) - outputs nFPM's JSON schema -* [nfpm package](/cmd/nfpm_package/) - creates a package based on the given the given config file and flags +* [nfpm init](/cmd/nfpm_init/) - Creates a sample nfpm.yaml config file +* [nfpm jsonschema](/cmd/nfpm_jsonschema/) - Outputs nFPM's JSON schema +* [nfpm package](/cmd/nfpm_package/) - Creates a package based on the given the given config file and flags diff --git a/www/docs/cmd/nfpm_completion.md b/www/docs/cmd/nfpm_completion.md index 3e9c001..010ff59 100644 --- a/www/docs/cmd/nfpm_completion.md +++ b/www/docs/cmd/nfpm_completion.md @@ -16,7 +16,7 @@ See each sub-command's help for details on how to use the generated script. ## See also -* [nfpm](/cmd/nfpm/) - packages apps on RPM, Deb and APK formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb and APK formats based on a YAML configuration file * [nfpm completion bash](/cmd/nfpm_completion_bash/) - Generate the autocompletion script for bash * [nfpm completion fish](/cmd/nfpm_completion_fish/) - Generate the autocompletion script for fish * [nfpm completion powershell](/cmd/nfpm_completion_powershell/) - Generate the autocompletion script for powershell diff --git a/www/docs/cmd/nfpm_init.md b/www/docs/cmd/nfpm_init.md index f8f5e51..5633af1 100644 --- a/www/docs/cmd/nfpm_init.md +++ b/www/docs/cmd/nfpm_init.md @@ -1,6 +1,6 @@ # nfpm init -creates a sample nfpm.yaml config file +Creates a sample nfpm.yaml config file ``` nfpm init [flags] @@ -15,5 +15,5 @@ nfpm init [flags] ## See also -* [nfpm](/cmd/nfpm/) - packages apps on RPM, Deb and APK formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb and APK formats based on a YAML configuration file diff --git a/www/docs/cmd/nfpm_jsonschema.md b/www/docs/cmd/nfpm_jsonschema.md index fdf9397..67e266b 100644 --- a/www/docs/cmd/nfpm_jsonschema.md +++ b/www/docs/cmd/nfpm_jsonschema.md @@ -1,6 +1,6 @@ # nfpm jsonschema -outputs nFPM's JSON schema +Outputs nFPM's JSON schema ``` nfpm jsonschema [flags] @@ -15,5 +15,5 @@ nfpm jsonschema [flags] ## See also -* [nfpm](/cmd/nfpm/) - packages apps on RPM, Deb and APK formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb and APK formats based on a YAML configuration file diff --git a/www/docs/cmd/nfpm_package.md b/www/docs/cmd/nfpm_package.md index bdf089e..1b70997 100644 --- a/www/docs/cmd/nfpm_package.md +++ b/www/docs/cmd/nfpm_package.md @@ -1,6 +1,6 @@ # nfpm package -creates a package based on the given the given config file and flags +Creates a package based on the given the given config file and flags ``` nfpm package [flags] @@ -17,5 +17,5 @@ nfpm package [flags] ## See also -* [nfpm](/cmd/nfpm/) - packages apps on RPM, Deb and APK formats based on a YAML configuration file +* [nfpm](/cmd/nfpm/) - Packages apps on RPM, Deb and APK formats based on a YAML configuration file