docs: fix wording, links

closes #346

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>

.goreleaser.yml

@@ -91,7 +91,7 @@ brews:
     name: homebrew-tap
   folder: Formula
   homepage:  https://github.com/goreleaser/nfpm
-  description: NFPM is a simple, 0-dependencies, deb, rpm and apk packager.
+  description: nFPM is a simple, 0-dependencies, deb, rpm and apk packager.
   test: |
     system "#{bin}/nfpm -v"
   install: |-
@@ -102,7 +102,7 @@ brews:
 nfpms:
 - file_name_template: '{{ .ProjectName }}_{{ .Arch }}'
   homepage:  https://github.com/goreleaser/nfpm
-  description: NFPM is a simple, 0-dependencies, deb, rpm and apk packager.
+  description: nFPM is a simple, 0-dependencies, deb, rpm and apk packager.
   maintainer: Carlos Alexandro Becker <root@carlosbecker.com>
   license: MIT
   vendor: GoReleaser
@@ -122,7 +122,7 @@ scoop:
     owner: goreleaser
     name: scoop-bucket
   homepage:  https://goreleaser.com
-  description: NFPM is a simple, 0-dependencies, deb, rpm and apk packager.
+  description: nFPM is a simple, 0-dependencies, deb, rpm and apk packager.
   license: MIT
 release:
   discussion_category_name: "New Releases"

README.md

@@ -1,7 +1,7 @@
 <p align="center">
   <img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" />
-  <h3 align="center">NFPM</h3>
-  <p align="center">NFPM is a simple, 0-dependencies, deb, rpm and apk packager.</p>
+  <h3 align="center">nFPM</h3>
+  <p align="center">nFPM is a simple, 0-dependencies, deb, rpm and apk packager.</p>
   <p align="center">
     <a href="https://github.com/goreleaser/nfpm/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/goreleaser/nfpm.svg?style=for-the-badge"></a>
     <a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge"></a>
@@ -21,7 +21,7 @@ and other softwares.
 I wanted something that could be used as a binary and/or as a library and that
 was really simple.
 
-So I created NFPM: a simpler, 0-dependency, as-little-assumptions-as-possible alternative to fpm.
+So I created nFPM: a simpler, 0-dependency, as-little-assumptions-as-possible alternative to fpm.
 
 ## Usage
 

internal/cmd/completion.go

@@ -10,8 +10,8 @@ func newCompletionCmd() *completionCmd {
 	root := &completionCmd{}
 	cmd := &cobra.Command{
 		Use:   "completion [bash|zsh|fish]",
-		Short: "Prints shell autocompletion scripts for NFPM",
-		Long: `Allows you to setup your shell to completions NFPM commands and flags.
+		Short: "Prints shell autocompletion scripts for nFPM",
+		Long: `Allows you to setup your shell to completions nFPM commands and flags.
 
 #### Bash
 

internal/cmd/docs.go

@@ -15,7 +15,7 @@ func newDocsCmd() *docsCmd {
 	root := &docsCmd{}
 	cmd := &cobra.Command{
 		Use:                   "docs",
-		Short:                 "Generates NFPM's command line docs",
+		Short:                 "Generates nFPM's command line docs",
 		SilenceUsage:          true,
 		DisableFlagsInUseLine: true,
 		Hidden:                true,
@@ -25,7 +25,7 @@ func newDocsCmd() *docsCmd {
 			return doc.GenMarkdownTreeCustom(root.cmd.Root(), "www/docs/cmd", func(_ string) string {
 				return ""
 			}, func(s string) string {
-				return "/cmd/" + strings.TrimSuffix(s, ".md")
+				return "/cmd/" + strings.TrimSuffix(s, ".md") + "/"
 			})
 		},
 	}

internal/cmd/root.go

@@ -35,7 +35,7 @@ func newRootCmd(version string, exit func(int)) *rootCmd {
 	cmd := &cobra.Command{
 		Use:           "nfpm",
 		Short:         "Packages apps on RPM, Deb and APK formats based on a YAML configuration file",
-		Long:          `NFPM is a simple, 0-dependencies, deb, rpm and apk packager.`,
+		Long:          `nFPM is a simple, 0-dependencies, deb, rpm and apk packager.`,
 		Version:       version,
 		SilenceUsage:  true,
 		SilenceErrors: true,

scripts/cmd_docs.sh

@@ -6,8 +6,7 @@ if which gsed >/dev/null 2>&1; then
 	SED="gsed"
 fi
 
-rm -rf www/docs/cmd/
-mkdir -p www/docs/cmd/
+rm -rf www/docs/cmd/*.md
 go run ./cmd/nfpm docs
 "$SED" \
 	-i'' \

www/docs/cmd/nfpm.md

@@ -4,7 +4,7 @@ Packages apps on RPM, Deb and APK formats based on a YAML configuration file
 
 ## Synopsis
 
-NFPM is a simple, 0-dependencies, deb, rpm and apk packager.
+nFPM is a simple, 0-dependencies, deb, rpm and apk packager.
 
 ## Options
 
@@ -14,7 +14,7 @@ NFPM is a simple, 0-dependencies, deb, rpm and apk packager.
 
 ## See also
 
-* [nfpm completion](/cmd/nfpm_completion)	 - Prints shell autocompletion scripts for NFPM
-* [nfpm init](/cmd/nfpm_init)	 - Creates a sample nfpm.yaml config file
-* [nfpm package](/cmd/nfpm_package)	 - Creates a package based on the given the given config file and flags
+* [nfpm completion](/cmd/nfpm_completion/)	 - Prints shell autocompletion scripts for nFPM
+* [nfpm init](/cmd/nfpm_init/)	 - Creates a sample nfpm.yaml config file
+* [nfpm package](/cmd/nfpm_package/)	 - Creates a package based on the given the given config file and flags
 

www/docs/cmd/nfpm_completion.md

@@ -1,10 +1,10 @@
 # nfpm completion
 
-Prints shell autocompletion scripts for NFPM
+Prints shell autocompletion scripts for nFPM
 
 ## Synopsis
 
-Allows you to setup your shell to completions NFPM commands and flags.
+Allows you to setup your shell to completions nFPM commands and flags.
 
 ### Bash
 
@@ -56,5 +56,5 @@ nfpm completion [bash|zsh|fish]
 
 ## 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
 

www/docs/cmd/nfpm_init.md

@@ -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
 

www/docs/cmd/nfpm_package.md

@@ -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
 

www/docs/configuration.md

@@ -290,5 +290,5 @@ apk:
 
 Templating is not and will not be supported.
 
-If you really need it, you can build on top of NFPM, use `envsubst`, `jsonnet`
+If you really need it, you can build on top of nFPM, use `envsubst`, `jsonnet`
 or apply some other templating on top of it.

www/docs/index.md

@@ -1,8 +1,8 @@
-# NFPM
+# nFPM
 
 ![](/static/banner.svg)
 
-NFPM is a simple, 0-dependencies, `deb`, `rpm` and `apk` packager.
+nFPM is a simple, 0-dependencies, `deb`, `rpm` and `apk` packager.
 
 ## Why
 
@@ -12,10 +12,10 @@ and other softwares.
 I wanted something that could be used as a binary and/or as a library and that
 was really simple.
 
-So I decided to create NFPM: a **simpler**, **0-dependency**,
+So I decided to create nFPM: a **simpler**, **0-dependency**,
 **as-little-assumptions-as-possible** alternative to fpm.
 
-## NFPM is Not FPM
+## nFPM is not FPM
 
 This is a subtle way of saying it wont have all features, nor all
 formats that fpm has: it is supposed to be simpler.

www/docs/sponsors.md

@@ -2,7 +2,7 @@
 title: Sponsoring the Project
 ---
 
-Does you or your company use NFPM?
+Does you or your company use nFPM?
 You can help keep the project bug-free and feature rich by sponsoring the project and the maintainers.
 
 ## GitHub Sponsors

www/docs/usage.md

@@ -1,6 +1,6 @@
 # Usage
 
-NFPM can be used both as command line tool or as a library.
+nFPM can be used both as command line tool or as a library.
 
 ## Command Line
 
@@ -22,5 +22,5 @@ You can learn about it in more detail in the [command line reference section](/c
 ## Go Library
 
 Check out the [GoDocs page](https://pkg.go.dev/github.com/goreleaser/nfpm/v2?tab=doc),
-the [NFPM command line implementation](https://github.com/goreleaser/nfpm/blob/master/cmd/nfpm/main.go)
+the [nFPM command line implementation](https://github.com/goreleaser/nfpm/blob/master/cmd/nfpm/main.go)
 and [GoReleaser's usage](https://github.com/goreleaser/goreleaser/blob/master/internal/pipe/nfpm/nfpm.go).

www/mkdocs.yml

@@ -1,5 +1,6 @@
-site_name: NFPM
-site_description: NFPM is Not FPM - a simple deb, rpm and apk packager written in Go
+site_name: nFPM
+site_url: https://nfpm.goreleaser.com
+site_description: nFPM is not FPM - a simple deb, rpm and apk packager written in Go
 copyright: Made with ❤️ by GoReleaser contributors.
 repo_name: goreleaser/nfpm
 repo_url: https://github.com/goreleaser/nfpm
@@ -13,8 +14,6 @@ theme:
   favicon: static/favicon.ico
   include_search_page: false
   search_index_only: true
-  features:
-    - navigation.instant
   palette:
     - media: "(prefers-color-scheme: light)"  # Light mode
       scheme: default
@@ -45,15 +44,11 @@ extra:
     - icon: fontawesome/brands/twitter
       link: https://twitter.com/goreleaser
 
-google_analytics:
-  - UA-106198408-1
-  - auto
-
 nav:
-- index.md
+- Home: index.md
 - install.md
 - usage.md
-- Command Line Reference:
+- Command Line Usage:
     - nfpm: cmd/nfpm.md
     - nfpm init: cmd/nfpm_init.md
     - nfpm package: cmd/nfpm_package.md