forking a vanilla Docker image from the GH action repo

README.md

@@ -1,35 +1,37 @@
-# GitHub Action for [Hugo](https://github.com/gohugoio/hugo) ✏️ 
+# ✏️ [Hugo](https://github.com/gohugoio/hugo) via Docker 
 
-![Build docs](https://github.com/jakejarvis/hugo-build-action/workflows/Build%20docs/badge.svg)
+[![Build docs](https://img.shields.io/docker/cloud/build/jakejarvis/hugo-extended?label=Docker%20Hub&logo=docker&logoColor=%23fff)](https://hub.docker.com/r/jakejarvis/hugo-extended)
 
-This is a simple GitHub Action that contains [Hugo](https://github.com/gohugoio/hugo), the popular static site generator. The [extended version](https://gohugo.io/troubleshooting/faq/#i-get-tocss-this-feature-is-not-available-in-your-current-hugo-version) is now bundled by default. Unlike other actions, this action includes releases going back to [v0.27](https://github.com/gohugoio/hugo/releases/tag/v0.27) (September 2017) for any compatibility requirements.
+A base image to ease local development of Hugo sites, including [Hugo Extended](https://gohugo.io/troubleshooting/faq/#i-get-tocss-this-feature-is-not-available-in-your-current-hugo-version) (with SASS/SCSS support) and third-party tools [listed below](#third-party-software).
 
 ## Usage
 
-### `workflow.yml` Example
+### Command line
 
-This example simply uploads the `./public` directory (the built Hugo website) as an artifact. You can replace the last `actions/upload-artifact` step with another action, like James Ives' [GitHub Pages deploy action](https://github.com/JamesIves/github-pages-deploy-action) or my [S3 sync action](https://github.com/jakejarvis/s3-sync-action), to upload the built static site somewhere accessible.
-
-Replace the `master` in `uses: jakejarvis/hugo-build-action@master` to specify the Hugo version, back to [v0.27](https://github.com/gohugoio/hugo/releases/tag/v0.27), like `hugo-build-action@v0.27`. This might be necessary if a recent version broke compatibility with your site. Otherwise, you'll get the [latest version](https://github.com/gohugoio/hugo/releases).
-
-The `with: args:` portion holds any [optional flags](https://gohugo.io/commands/hugo/). You can remove those two lines for a vanilla build.
-
-```yaml
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - uses: jakejarvis/hugo-build-action@master  # ...or replace 'master' with a full version tag, such as: v0.64.1
-      with:
-        args: --minify --buildDrafts
-    - uses: actions/upload-artifact@master
-      with:
-        name: website
-        path: './public'
+```bash
+docker run -v $(pwd):/src -p 1313:1313 jakejarvis/hugo-extended:latest server --buildDrafts --buildFuture --bind 0.0.0.0
 ```
 
-## Included Software
+### `docker-compose.yml`
+
+```yaml
+version: 3
+
+services:
+  hugo:
+    image: jakejarvis/hugo-extended:latest
+    ports:
+      - 1313:1313
+    volumes:
+      - ./:/src
+    command: server --buildDrafts --buildFuture --bind 0.0.0.0
+```
+
+### Live server
+
+When using Docker to run a live server (via `hugo server`), you must pass `--bind 0.0.0.0` as an argument to fix some networking quirks between Hugo, the container, and the host.
+
+## Third-party software
 
 Just in case, the final container includes a few small third-party tools that are required by certain optional Hugo features: