tools to build and deploy static HTML and initial version of PDF

Author: PhilippSalvisberg

docker/Dockerfile

@@ -0,0 +1,38 @@
+FROM ubuntu:18.04
+
+LABEL maintainer="philipp.salvisberg@trivadis.com"
+LABEL description="Tools to generate website, pdf and ebook using Materials for MkDocs."
+LABEL build.command="docker build . --tag trivadis/mktools:latest"
+
+RUN apt-get update 
+RUN apt-get upgrade -y
+RUN apt-get install -y build-essential \
+                       python3-dev \
+                       python3-pip \
+                       python3-setuptools \
+                       python3-wheel \
+                       python3-cffi \
+                       libcairo2 \
+                       libpango-1.0-0 \
+                       libpangocairo-1.0-0 \
+                       libgdk-pixbuf2.0-0 \
+                       libffi-dev \
+                       shared-mime-info
+RUN apt-get install -y git
+RUN pip3 install --upgrade pip
+RUN pip3 install mkdocs \
+                 mkdocs-material \
+                 mkdocs-awesome-pages-plugin \
+                 pymdown-extensions \
+                 mike \
+                 weasyprint 
+
+ENV LC_ALL=C.UTF-8
+ENV LANG=C.UTF-8
+
+# volume for GitHub project's root folder containing docs folder  
+RUN mkdir /data
+VOLUME ["/data"]
+
+# port for mkdocs serve
+EXPOSE 8000

genpdf-in-container.sh

@@ -0,0 +1,72 @@
+#/bin/bash
+
+function create_target_dir(){
+    rm -Rf ${TARGET_DIR}
+    mkdir -p ${TARGET_DIR}/docs
+}
+
+function copy_resources() {
+    cp ./mkdocs.yml ${TARGET_DIR}/mkdocs.yml
+    cp -r docs/images ${TARGET_DIR}/docs
+    cp -r docs/stylesheets ${TARGET_DIR}/docs/stylesheets
+}
+
+function write_file(){
+    FILE=$1
+    echo "" >> ${TARGET_DIR}/docs/index.md
+    sed -e 's/..\/image/image/g' docs/${FILE} | sed -e 's/✘/X/g' >> ${TARGET_DIR}/docs/index.md
+}
+
+function write_text(){
+    TEXT=$1
+    echo "" >> ${TARGET_DIR}/docs/index.md
+    echo "${TEXT}" >> ${TARGET_DIR}/docs/index.md
+}
+
+function write_guidelines(){
+    DIR=$1
+    FIRST_HEADER=$2
+    for f in docs/${DIR}/g-*.md
+    do
+        echo "" >> ${TARGET_DIR}/docs/index.md
+        sed -e "s|# |${FIRST_HEADER} |g" $f >> ${TARGET_DIR}/docs/index.md
+    done
+}
+
+function convert_to_pdf(){
+    cd ${TARGET_DIR}
+    mkdocs build
+    cd site
+    weasyprint index.html ../../plsql.pdf
+}
+
+TARGET_DIR=work-pdf
+
+create_target_dir
+copy_resources
+write_file "index.md"
+write_file "1-introduction/introduction.md"
+write_file "2-naming-conventions/naming-conventions.md"
+write_file "3-coding-style/coding-style.md"
+write_text "# Language Usage"
+write_text "## General"
+write_guidelines "4-language-usage/1-general" "###"
+write_text "## Numeric Data Types"
+write_text "### General"
+write_guidelines "4-language-usage/2-variables-and-types/1-general" "####"
+write_text "### Numeric Data Types"
+write_guidelines "4-language-usage/2-variables-and-types/2-numeric-data-types" "####"
+write_text "### Character Data Types"
+write_guidelines "4-language-usage/2-variables-and-types/3-character-data-types" "####"
+write_text "### Boolean Data Types"
+write_guidelines "4-language-usage/2-variables-and-types/4-boolean-data-types" "####"
+write_text "### Large Objects"
+write_guidelines "4-language-usage/2-variables-and-types/5-large-objects" "####"
+write_text "## DML & SQL"
+write_text "### General"
+write_guidelines "4-language-usage/3-dml-and-sql/1-general" "####"
+write_file "5-complexity-analysis/complexity-analysis.md"
+write_file "6-code-reviews/code-reviews.md"
+write_file "7-tool-support/tool-support.md"
+write_file "9-appendix/appendix.md"
+convert_to_pdf

genpdf.sh

@@ -0,0 +1,3 @@
+#/bin/bash
+
+docker run -v $(pwd):/data --rm -it trivadis/mktools bash -c "cd /data; ./genpdf-in-container.sh"

gh-deploy.sh

@@ -0,0 +1,3 @@
+#/bin/bash
+
+docker run -v $(pwd):/data -p 8000:8000 --rm -it trivadis/mktools bash -c "cd /data; mkdocs gh-deploy"

serve.sh

@@ -0,0 +1,3 @@
+#/bin/bash
+
+docker run -v $(pwd):/data -p 8000:8000 --rm -it trivadis/mktools bash -c "cd /data; mkdocs serve -a 0.0.0.0:8000"