Use mkdocs-material 9. (#108)

* Use mkdocs-material 9.

Bumping major version of mkdocs to 9. It includes some nice improvements to search but nothing else relevant to our docs.

Also picking up python 3.11 and nginx 1.22.

* build: Docker cleanup/update.

- Use Alpine version of nginx image (23MB instead of 142MB)
- Fix MIME type for rss feeds.
- Clean up .gitignore and .dockerignore.
- Ensure scripts fail on error.

Author: jholdstock

.dockerignore

@@ -1,7 +1,9 @@
-bin/build.sh
-Dockerfile
-README.md
-.git
 .gitignore
+.git
+.github
+LICENSE
+README.md
 
-site/
+bin/build.sh
+site
+.cache

.github/workflows/python.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9]
+        python-version: [3.11]
 
     steps:
     - uses: actions/checkout@v2

Dockerfile

@@ -1,5 +1,5 @@
 # Build image
-FROM python:3.9
+FROM python:3.11
 
 LABEL description="dcrdevdocs build"
 LABEL version="1.0"
@@ -18,7 +18,7 @@ RUN pip install mkdocs && \
 RUN ./bin/build_docs.sh
 
 # Serve image (stable nginx version)
-FROM nginx:1.20
+FROM nginx:1.22-alpine
 
 LABEL description="dcrdevdocs serve"
 LABEL version="1.0"

LICENSE

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2018-2021 The Decred developers
+Copyright (c) 2018-2023 The Decred developers
 
 Permission to use, copy, modify, and distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

bin/build.sh

@@ -1,19 +1,27 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
 # Requires docker 17.05 or higher
 
+set -e
+
 echo ""
-echo "================================="
+echo "===================================="
 echo "  Building dcrdevdocs docker image  "
-echo "================================="
+echo "===================================="
 echo ""
 
-docker build -t decred/dcrdevdocs .
+IMAGE_NAME=decred/dcrdevdocs
+
+if [ "$1" != "" ]; then
+    IMAGE_NAME=$1
+fi
+
+docker build -t $IMAGE_NAME .
 
 echo ""
 echo "==================="
 echo "  Build complete"
 echo "==================="
 echo ""
 echo "You can now run dcrdevdocs with the following command:"
-echo "    docker run -d --rm -p <local port>:80 decred/dcrdevdocs:latest"
+echo "    docker run -d --rm -p <local port>:80 $IMAGE_NAME:latest"
 echo ""

bin/build_docs.sh

@@ -1,4 +1,6 @@
-#!/bin/bash -e
+#!/usr/bin/env bash
+
+set -e
 
 echo ""
 echo "========================================="

conf/nginx.conf

@@ -13,13 +13,15 @@ server {
     server_name  localhost;
 
     charset utf-8;
+
+    # Hide Version
     server_tokens off;
 
-    #Security Headers
-    add_header X-Content-Type-Options "nosniff" always;
-    add_header X-Frame-Options "DENY" always;
-    add_header X-XSS-Protection "1; mode=block" always;
-    add_header Referrer-Policy "no-referrer" always;
+    # Security Headers
+    add_header X-Content-Type-Options "nosniff"       always;
+    add_header X-Frame-Options        "DENY"          always;
+    add_header X-XSS-Protection       "1; mode=block" always;
+    add_header Referrer-Policy        "no-referrer"   always;
 
     location / {
         root   /usr/share/nginx/html;
@@ -38,6 +40,6 @@ server {
     gzip_comp_level 6;
     gzip_buffers 16 8k;
     gzip_http_version 1.1;
-    gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss image/svg+xml text/javascript;
+    gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/rss+xml image/svg+xml text/javascript;
 
 }

docs/css/style.css

@@ -153,7 +153,8 @@ details .md-typeset__table code{
     font-size: 13px;
 }
 
-.md-typeset .admonition p{
+.md-typeset .admonition p,
+.md-typeset .admonition li {
     font-size: 14px;
 }
 

mkdocs.yml

@@ -116,4 +116,4 @@ nav:
   - 'Regnet': 'environments/regnet.md'
 - Contributing:
   - 'Contributor Guidelines': 'contributing/contributor-guidelines.md'
-copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdevdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdevdocs/compare">send a pull request</a>.<br />dcrdevdocs v0.0.1. Decred Project 2020.
+copyright: If you wish to improve this site, please <a href="https://github.com/decred/dcrdevdocs/issues/new">open an issue</a> or <a href="https://github.com/decred/dcrdevdocs/compare">send a pull request</a>.<br />dcrdevdocs v0.0.1. Decred Project 2020-2023.

requirements.txt

@@ -1,2 +1,2 @@
-mkdocs-material==8.2.8
+mkdocs-material==9.0.6
 mkdocs-markdownextradata-plugin==0.2.4