From 395046c3db83024a5e351e43a95218761cc33176 Mon Sep 17 00:00:00 2001 From: David Young Date: Mon, 20 Apr 2020 13:27:02 +1200 Subject: [PATCH] Bump version of material-mkdocs Signed-off-by: David Young --- Dockerfile | 3 +- .../extras/javascript/auto-expand-nav.js | 27 ++++++++++ manuscript/images/site-logo.svg | 49 +++++++++++++++++ manuscript/recipes/bookstack.md | 2 - .../recipes/general/ipad-pro-geeking.md | 1 + manuscript/recipes/general/kid-safe-wifi.md | 1 + manuscript/recipes/general/start.md | 0 manuscript/support.md | 6 ++- mkdocs.yml | 53 ++++++++++++------- scripts/serve.sh | 3 +- 10 files changed, 121 insertions(+), 24 deletions(-) create mode 100644 manuscript/extras/javascript/auto-expand-nav.js create mode 100644 manuscript/images/site-logo.svg create mode 100644 manuscript/recipes/general/ipad-pro-geeking.md create mode 100644 manuscript/recipes/general/kid-safe-wifi.md create mode 100644 manuscript/recipes/general/start.md diff --git a/Dockerfile b/Dockerfile index 64ae33c..f69e5d8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,5 @@ FROM squidfunk/mkdocs-material RUN pip install \ mkdocs-autolinks-plugin \ - mkdocs-htmlproofer-plugin \ No newline at end of file + mkdocs-htmlproofer-plugin \ + mkdocs-blog-plugin \ No newline at end of file diff --git a/manuscript/extras/javascript/auto-expand-nav.js b/manuscript/extras/javascript/auto-expand-nav.js new file mode 100644 index 0000000..00c64e3 --- /dev/null +++ b/manuscript/extras/javascript/auto-expand-nav.js @@ -0,0 +1,27 @@ +document.addEventListener("DOMContentLoaded", function() { + load_navpane(); +}); + +function load_navpane() { + var width = window.innerWidth; + if (width <= 1200) { + return; + } + + var nav = document.getElementsByClassName("md-nav"); + for(var i = 0; i < nav.length; i++) { + if (typeof nav.item(i).style === "undefined") { + continue; + } + + if (nav.item(i).getAttribute("data-md-level") && nav.item(i).getAttribute("data-md-component")) { + nav.item(i).style.display = 'block'; + nav.item(i).style.overflow = 'visible'; + } + } + + var nav = document.getElementsByClassName("md-nav__toggle"); + for(var i = 0; i < nav.length; i++) { + nav.item(i).checked = true; + } +} \ No newline at end of file diff --git a/manuscript/images/site-logo.svg b/manuscript/images/site-logo.svg new file mode 100644 index 0000000..970a3a5 --- /dev/null +++ b/manuscript/images/site-logo.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/manuscript/recipes/bookstack.md b/manuscript/recipes/bookstack.md index fe05804..0912182 100644 --- a/manuscript/recipes/bookstack.md +++ b/manuscript/recipes/bookstack.md @@ -1,5 +1,3 @@ -hero: Heroic Hero - # BookStack BookStack is a simple, self-hosted, easy-to-use platform for organising and storing information. diff --git a/manuscript/recipes/general/ipad-pro-geeking.md b/manuscript/recipes/general/ipad-pro-geeking.md new file mode 100644 index 0000000..5ab2f8a --- /dev/null +++ b/manuscript/recipes/general/ipad-pro-geeking.md @@ -0,0 +1 @@ +Hello \ No newline at end of file diff --git a/manuscript/recipes/general/kid-safe-wifi.md b/manuscript/recipes/general/kid-safe-wifi.md new file mode 100644 index 0000000..5ab2f8a --- /dev/null +++ b/manuscript/recipes/general/kid-safe-wifi.md @@ -0,0 +1 @@ +Hello \ No newline at end of file diff --git a/manuscript/recipes/general/start.md b/manuscript/recipes/general/start.md new file mode 100644 index 0000000..e69de29 diff --git a/manuscript/support.md b/manuscript/support.md index 3e976e7..fed1798 100644 --- a/manuscript/support.md +++ b/manuscript/support.md @@ -1,7 +1,9 @@ -hero: "Excuse me... waiter, there's a bug in this recipe!" - # Support +> "Excuse me... waiter, there's a bug in this recipe!" + +How do you get support for these receipes? There are several options... + ## Discord: Where the cool kids are All the cool kids are hanging out in the [Discord server](http://chat.funkypenguin.co.nz). diff --git a/mkdocs.yml b/mkdocs.yml index 66e8415..f40c582 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,6 +19,7 @@ copyright: 'Copyright © 2016 - 2020 David Young, Funky Penguin Limited' # Plugins plugins: + - blog - search - minify: minify_html: true @@ -26,16 +27,23 @@ plugins: # - git-revision-date-localized: # type: date - autolinks - - htmlproofer + # - htmlproofer #theme_dir: mkdocs-material nav: - Home: - What is this: index.md - About: whoami.md - - Sponsored Projects: sponsored-projects.md - - Support: - - Support: support.md + - Sponsored Projects: sponsored-projects.md + # - 'Join Us! 🤝': + # - Hello: recipes/general/start.md + # - iPad Pro Geeking: recipes/general/ipad-pro-geeking.md + # - Kid-safe WiFi: recipes/general/kid-safe-wifi.md + # Upcoming section + # - '#geeklife': + # - Hello: recipes/general/start.md + # - iPad Pro Geeking: recipes/general/ipad-pro-geeking.md + # - Kid-safe WiFi: recipes/general/kid-safe-wifi.md - Docker Swarm: - Preparation: - Design: ha-docker-swarm/design.md @@ -166,36 +174,42 @@ nav: # - PrivateBin: recipes/kubernetes/privatebin.md - CHANGELOG: - CHANGELOG: CHANGELOG.md + - Support: + - Support: support.md theme: name: 'material' custom_dir: 'overrides' disqus: 'geeks-cookbook' - logo: 'images/site-logo.png' - favicon: 'images/favicon.ico' - feature: - tabs: true + logo: 'images/site-logo.svg' + favicon: 'images/site-logo.svg' + features: + - tabs + - instant + icon: + repo: 'fontawesome/brands/github' palette: primary: 'black' accent: 'indigo' font: text: 'Ubuntu' code: 'Ubuntu Mono' + +extra: social: - - type: 'github' + - icon: 'fontawesome/brands/github' link: 'https://github.com/funkypenguin' - - type: 'twitter' + - icon: 'fontawesome/brands/twitter' link: 'https://twitter.com/funkypenguin' - - type: 'stack-overflow' + - icon: 'fontawesome/brands/stack-overflow' link: 'https://stackoverflow.com/cv/funkypenguin' - - type: 'rss' + - icon: 'material/rss' link: 'https://www.funkypenguin.co.nz/' - - type: 'linkedin' + - icon: 'fontawesome/brands/linkedin' link: 'https://www.linkedin.com/in/funkypenguin' - - type: 'envelope' - link: 'mailto:davidy@funkypenguin.co.nz?Subject=Hello%2C%20from%20a%20geek-cookbook%20reader%20%3B%29' - - type: 'book' - link: 'https://leanpub.com/geeks-cookbook' + - icon: 'material/library' + link: 'https://leanpub.com/geeks-cookbook' + # Google Analytics google_analytics: @@ -222,7 +236,9 @@ markdown_extensions: - pymdownx.caret - pymdownx.critic - pymdownx.details - - pymdownx.emoji + - pymdownx.emoji: + emoji_index: !!python/name:pymdownx.emoji.twemoji + emoji_generator: !!python/name:pymdownx.emoji.to_svg - pymdownx.inlinehilite - pymdownx.magiclink: repo_url_shorthand: true @@ -234,4 +250,5 @@ markdown_extensions: - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde + - pymdownx.tabbed - meta diff --git a/scripts/serve.sh b/scripts/serve.sh index 769dc3e..44d0556 100755 --- a/scripts/serve.sh +++ b/scripts/serve.sh @@ -1,3 +1,4 @@ #!/bin/bash +docker pull squidfunk/mkdocs-material:5.1.1 docker build . -t funkypenguin/mkdocs-material -docker run --rm --name mkdocs-material -it -p 8000:8000 -v ${PWD}:/docs funkypenguin/mkdocs-material +docker run --rm --name mkdocs-material -it -p 8123:8000 -v ${PWD}:/docs funkypenguin/mkdocs-material