Skip to content

Commit

Permalink
Material version updates and added social cards, cookie consent and f…
Browse files Browse the repository at this point in the history
…eedback functionality
  • Loading branch information
Himangini committed Sep 7, 2023
1 parent 2aefaf0 commit 455e758
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,6 @@ dist/
# Debug logs
logs/*
.DS_Store

# Ignore social cards cache
userdocs/.cache/*
32 changes: 29 additions & 3 deletions userdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -13,16 +14,16 @@ 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'
palette:
- 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
Expand Down Expand Up @@ -57,6 +58,9 @@ plugins:
- glightbox
- minify:
minify_html: true
- social:
cards: true
cards_font: Roboto

# Customization
extra:
Expand All @@ -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
<a href="https://github.com/eksctl-io/eksctl/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form <a>.
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
Expand Down
13 changes: 11 additions & 2 deletions userdocs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
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
libcairo2-dev
libfreetype6-dev
libffi-dev
libjpeg-dev
libpng-dev
libz-dev
pngquant
File renamed without changes
File renamed without changes

0 comments on commit 455e758

Please sign in to comment.