diff --git a/.gitignore b/.gitignore
index 01dd0eb0f5..7dfabf6980 100644
--- a/.gitignore
+++ b/.gitignore
@@ -44,3 +44,6 @@ dist/
# Debug logs
logs/*
.DS_Store
+
+# Ignore social cards cache
+userdocs/.cache/*
diff --git a/Makefile.docs b/Makefile.docs
index ca5eeebbe0..8d2b08fd14 100644
--- a/Makefile.docs
+++ b/Makefile.docs
@@ -7,6 +7,7 @@ userdocs/src/usage/schema.json: pkg/apis/eksctl.io/v1alpha5/assets/schema.json
.PHONY: install-site-deps
install-site-deps: ## Install dependencies for user docs
pip3 install -r userdocs/requirements.txt
+ sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant
.PHONY: serve-pages
serve-pages: ## Serve the site locally
diff --git a/README.md b/README.md
index ab91f8b287..e568ede36b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# `eksctl` - The official CLI for Amazon EKS !
+# `eksctl` - The official CLI for Amazon EKS !
[![Go Report Card](https://goreportcard.com/badge/github.com/eksctl-io/eksctl)](https://goreportcard.com/report/github.com/eksctl-io/eksctl)
diff --git a/userdocs/mkdocs.yml b/userdocs/mkdocs.yml
index 187a9ab04f..e7c356ba50 100644
--- a/userdocs/mkdocs.yml
+++ b/userdocs/mkdocs.yml
@@ -2,6 +2,7 @@
site_name: eksctl
site_description: 'The official CLI for Amazon EKS'
site_author: 'eksctl authors'
+site_url: https://eksctl.io
# Repository
repo_name: 'eksctl-io/eksctl'
@@ -13,8 +14,8 @@ edit_uri: ""
theme:
name: 'material'
custom_dir: 'theme'
- favicon: 'assets/images/favicon.png'
- logo: 'assets/images/logo.png'
+ favicon: 'img/favicon.png'
+ logo: 'img/logo.png'
font:
text: 'Segoe UI'
code: 'Roboto Mono'
@@ -22,7 +23,7 @@ theme:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
- icon: fontawesome/solid/moon
+ icon: material/weather-night
name: Switch to dark mode
primary: black
accent: indigo
@@ -57,6 +58,9 @@ plugins:
- glightbox
- minify:
minify_html: true
+ - social:
+ cards: true
+ cards_font: Roboto
# Customization
extra:
@@ -74,6 +78,28 @@ extra:
analytics:
provider: google
property: G-EQKYCQY5Q2
+ feedback:
+ title: Was this page helpful?
+ ratings:
+ - icon: material/thumb-up-outline
+ name: This page was helpful
+ data: 1
+ note: >-
+ Thanks for your feedback!
+ - icon: material/thumb-down-outline
+ name: This page could be improved
+ data: 0
+ note: >-
+ Thanks for your feedback! Help us improve this page by using our
+ feedback form .
+ consent:
+ title: Cookie consent
+ description: >-
+ We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users
+ find what they're searching for. With your consent, you're helping us to make our documentation better.
+ actions:
+ - accept
+ - manage
extra_css:
- stylesheets/extra.css
diff --git a/userdocs/requirements.txt b/userdocs/requirements.txt
index b431435ec6..6502bb7938 100644
--- a/userdocs/requirements.txt
+++ b/userdocs/requirements.txt
@@ -1,12 +1,14 @@
-mkdocs == 1.4.2
-mkdocs-material == 9.0.6
+mkdocs == 1.5.2
+mkdocs-material == 9.2.7
mkdocs-redirects
mkdocs-minify-plugin
mkdocs-glightbox
pymdown-extensions >= 9.9.1
jinja2 == 3.1.2
+pillow
+cairosvg
# Dependencies from material theme
mkdocs-material-extensions>=1.1
pygments>=2.12
-markdown>=3.2
+markdown>=3.2
\ No newline at end of file
diff --git a/userdocs/theme/assets/images/favicon.png b/userdocs/src/img/favicon.png
similarity index 100%
rename from userdocs/theme/assets/images/favicon.png
rename to userdocs/src/img/favicon.png
diff --git a/userdocs/theme/assets/images/logo.png b/userdocs/src/img/logo.png
similarity index 100%
rename from userdocs/theme/assets/images/logo.png
rename to userdocs/src/img/logo.png