From 6fb8050d0afce1e755534f4801defb4b32228825 Mon Sep 17 00:00:00 2001 From: David Young Date: Thu, 26 Mar 2020 09:38:30 +1300 Subject: [PATCH] Add some sexy new mkdocs plugins --- Dockerfile | 4 ++++ mkdocs.yml | 4 +++- requirements.txt | 2 ++ scripts/serve.sh | 3 ++- 4 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..64ae33c --- /dev/null +++ b/Dockerfile @@ -0,0 +1,4 @@ +FROM squidfunk/mkdocs-material +RUN pip install \ + mkdocs-autolinks-plugin \ + mkdocs-htmlproofer-plugin \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7414079..bcb87e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ repo_url: 'https://github.com/funkypenguin/geek-cookbook' docs_dir: 'manuscript' # Copyright -copyright: 'Copyright © 2016 - 2019 David Young, Funky Penguin Limited' +copyright: 'Copyright © 2016 - 2020 David Young, Funky Penguin Limited' # Plugins plugins: @@ -24,6 +24,8 @@ plugins: minify_html: true - git-revision-date-localized: type: date + - autolinks + - htmlproofer #theme_dir: mkdocs-material nav: diff --git a/requirements.txt b/requirements.txt index eef5584..c158a23 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,5 @@ mkdocs-material>=4.4.3 pymdown-extensions>=6.0 Markdown>=3.0.1 mkdocs-minify-plugin>=0.2 +mkdocs-autolinks-plugin>=0.2.0 +mkdocs-htmlproofer-plugin>=0.0.3 \ No newline at end of file diff --git a/scripts/serve.sh b/scripts/serve.sh index 55b8ea5..769dc3e 100755 --- a/scripts/serve.sh +++ b/scripts/serve.sh @@ -1,2 +1,3 @@ #!/bin/bash -docker run --rm --name mkdocs-material -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material +docker build . -t funkypenguin/mkdocs-material +docker run --rm --name mkdocs-material -it -p 8000:8000 -v ${PWD}:/docs funkypenguin/mkdocs-material