docs: enable content editing option and revision [skip ci]

.gitignore

@@ -25,6 +25,7 @@ TODO
 docs/site
 docs/*/**.html
 */**/*.1
+docs/docs
 
 !/docs
 !/tests/fixtures/**/*

Makefile

@@ -262,7 +262,13 @@ docs-deploy:
 	@git stash
 	@rm -rf /tmp/docs
 	@mkdir -p /tmp/docs
-	@docker run -it --rm -v $(PWD)/docs:/docs -v /tmp/docs:/tmp/docs squidfunk/mkdocs-material build
+	@docker-compose -f docs/docker-compose.yml build
+	@docker run -it --rm \
+		-v $(PWD)/.git:/docs/.git \
+		-v $(PWD)/docs/content:/docs/docs/content \
+		-v $(PWD)/docs/mkdocs.yml:/docs/mkdocs.yml \
+		-v /tmp/docs:/tmp/docs \
+			static-web-server-docs mkdocs build
 	@git checkout gh-pages
 	@git clean -fdx
 	@cp -rf docs/CNAME /tmp/docs/

docs/Dockerfile

@@ -0,0 +1,17 @@
+FROM squidfunk/mkdocs-material
+
+RUN set -eux \
+    && apk upgrade --update-cache -a \
+    && pip3 install \
+        mkdocs-git-revision-date-localized-plugin \
+    && true
+
+COPY ./entrypoint.sh /
+
+WORKDIR /docs
+
+EXPOSE 8000
+
+ENTRYPOINT ["/entrypoint.sh"]
+
+CMD ["mkdocs", "serve", "--dev-addr=0.0.0.0:8000"]

docs/docker-compose.yml

@@ -1,8 +1,13 @@
 version: "3.3"
 services:
   server:
-    image: squidfunk/mkdocs-material
+    container_name: static-web-server-docs
+    image: static-web-server-docs
+    build:
+      dockerfile: Dockerfile
     ports:
       - 8000:8000
     volumes:
-      - ./:/docs
+      - ../.git:/docs/.git
+      - ./content:/docs/docs/content
+      - ./mkdocs.yml:/docs/mkdocs.yml

docs/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+set -e
+
+# Check if incoming command contains flags.
+if [ "${1#-}" != "$1" ]; then
+    set -- mkdocs "$@"
+fi
+
+exec "$@"

docs/mkdocs.yml

@@ -10,7 +10,7 @@ repo_name: static-web-server/static-web-server
 repo_url: https://github.com/static-web-server/static-web-server/
 edit_uri: edit/master/docs/content/
 
-docs_dir: 'content'
+docs_dir: 'docs/content'
 site_dir: '/tmp/docs'
 extra_css:
   - 'assets/style.css'
@@ -26,6 +26,8 @@ theme:
   include_sidebar: true
   features:
     - content.code.annotate
+    - content.action.edit
+    - content.action.view
     - content.tabs.link
     - header.autohide
     # - navigation.expand
@@ -112,6 +114,17 @@ plugins:
   - search
   - minify:
       minify_html: true
+  - git-revision-date-localized:
+      type: timeago
+      custom_format: "%d. %B %Y"
+      timezone: Europe/Berlin
+      locale: en
+      fallback_to_build_date: false
+      enable_creation_date: false
+      exclude:
+        - index.md
+      enabled: true
+      strict: true
 
 # Content Navigation
 nav: