Touching up more mkdocs details

.github/workflows/cli.yml

@@ -92,3 +92,17 @@ jobs:
         run: |
           git diff --exit-code
           git diff --cached --exit-code
+
+  publish:
+    if: startswith(github.ref, 'refs/tags/')
+    name: publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Publish Docs
+        uses: mhausenblas/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.MKDOCS_PUBLISH_GITHUB_TOKEN }}
+          REQUIREMENTS: mkdocs-requirements.txt

.gitignore

@@ -1,10 +1,10 @@
 *.coverprofile
 *.orig
-node_modules/
 vendor
 .idea
 internal/*/built-example
 coverage.txt
 /.local/
+/site/
 
 *.exe

Makefile

@@ -30,3 +30,15 @@ gfmrun:
 .PHONY: toc
 toc:
 	go run internal/build/build.go toc docs/v2/manual.md
+
+.PHONY: docs
+docs:
+	mkdocs build
+
+.PHONY: docs-deps
+docs-deps:
+	pip install -r mkdocs-requirements.txt
+
+.PHONY: serve-docs
+serve-docs:
+	mkdocs serve

docs/CNAME

@@ -0,0 +1 @@
+cli.urfave.org

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+../CODE_OF_CONDUCT.md

docs/CONTRIBUTING.md

@@ -98,6 +98,28 @@ line help system which may be consulted for further information, e.g.:
 go run internal/genflags/cmd/genflags/main.go --help
 ```
 
+#### docs output
+
+The documentation in the `docs` directory is automatically built via `mkdocs` into a
+static site and published when releases are pushed (see [RELEASING](./RELEASING/)). There
+is no strict requirement to build the documentation when developing locally, but the
+following `make` targets may be used if desired:
+
+```sh
+# install documentation dependencies with `pip`
+make docs-deps
+```
+
+```sh
+# build the static site in `./site`
+make docs
+```
+
+```sh
+# start an mkdocs development server
+make serve-docs
+```
+
 ### pull requests
 
 Please feel free to open a pull request to fix a bug or add a feature. The @urfave/cli

docs/index.md

@@ -16,5 +16,6 @@ These are the guides for each major supported version:
 
 In addition to the version-specific guides, these other documents are available:
 
-- [`CONTRIBUTING`](./CONTRIBUTING/)
+- [CONTRIBUTING](./CONTRIBUTING/)
-- [`RELEASING`](./RELEASING/)
+- [CODE OF CONDUCT](./CODE_OF_CONDUCT/)
+- [RELEASING](./RELEASING/)

mkdocs-requirements.txt

@@ -1,4 +1,4 @@
-mkdocs
+mkdocs~=1.3
-mkdocs-material
+mkdocs-material~=8.2
-mkdocs-git-revision-date-localized-plugin
+mkdocs-git-revision-date-localized-plugin~=1.0
-pygments
+pygments~=2.12