diff --git a/mkdocs.yml b/mkdocs.yml index 1dec436..7b878b0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,16 +5,23 @@ repo_url: null edit_uri: blob/main/content/ use_directory_urls: false extra_css: - - stylesheets/extra.css + - stylesheets/extra.css theme: - name: material - font: - text: Montserrat - code: Montserrat Mono - custom_dir: dist/_theme - logo: assets/images/favicon.svg - favicon: assets/images/favicon.svg - palette: + name: material + font: + text: Space Grotex + code: Space Grotex + # To add custom stylesheet to _theme and acts as a build-directory path resolver + custom_dir: dist/_theme + logo_light: assets/images/logo-light.png + logo_dark: assets/images/logo-dark.png + cloud_security_alliance_logo_dark: assets/images/CSA_dark.png + cloud_security_alliance_logo_light: assets/images/CSA_light.png + hippa_compliant_logo_dark: assets/images/HC_dark.png + hippa_compliant_logo_light: assets/images/HC_light.png + favicon: assets/images/logo-light.png + + palette: - media: "(prefers-color-scheme)" toggle: name: Switch to system preference @@ -33,12 +40,11 @@ theme: toggle: name: Switch to dark mode icon: material/brightness-3 - features: - - content.code.copy - - navigation.tracking - - toc.follow - - toc.integrate - - navigation.top + features: + - content.code.copy + - navigation.tracking + - toc.follow + - navigation.top markdown_extensions: - admonition @@ -46,31 +52,32 @@ markdown_extensions: - pymdownx.superfences - attr_list - pymdownx.emoji: - emoji_generator: !!python/name:material.extensions.emoji.to_svg - emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - toc: permalink: "#" + title: On this page extra: - analytics: - provider: google - property: G-TTH1YYW5TX - consent: - title: Cookie consent - actions: - - accept - - reject - - manage - 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. - version: - provider: mike - default: latest + analytics: + provider: google + property: G-TTH1YYW5TX + consent: + title: Cookie consent + actions: + - accept + - reject + - manage + 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. + version: + provider: mike + default: latest plugins: - - search - - mermaid2 - - glightbox + - search + - mermaid2 + - glightbox nav: diff --git a/resources/assets/images/CSA_dark.png b/resources/assets/images/CSA_dark.png new file mode 100644 index 0000000..ef3fd82 Binary files /dev/null and b/resources/assets/images/CSA_dark.png differ diff --git a/resources/assets/images/CSA_light.png b/resources/assets/images/CSA_light.png new file mode 100644 index 0000000..9893cab Binary files /dev/null and b/resources/assets/images/CSA_light.png differ diff --git a/resources/assets/images/HC_dark.png b/resources/assets/images/HC_dark.png new file mode 100644 index 0000000..cf55812 Binary files /dev/null and b/resources/assets/images/HC_dark.png differ diff --git a/resources/assets/images/HC_light.png b/resources/assets/images/HC_light.png new file mode 100644 index 0000000..ce82adb Binary files /dev/null and b/resources/assets/images/HC_light.png differ diff --git a/resources/assets/images/favicon.svg b/resources/assets/images/favicon.svg deleted file mode 100644 index a6762cd..0000000 --- a/resources/assets/images/favicon.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/resources/assets/images/logo-dark.png b/resources/assets/images/logo-dark.png new file mode 100644 index 0000000..a138c75 Binary files /dev/null and b/resources/assets/images/logo-dark.png differ diff --git a/resources/assets/images/logo-light.png b/resources/assets/images/logo-light.png new file mode 100644 index 0000000..97a083f Binary files /dev/null and b/resources/assets/images/logo-light.png differ diff --git a/resources/assets/svg/down-arrow.svg b/resources/assets/svg/down-arrow.svg new file mode 100644 index 0000000..6e4849f --- /dev/null +++ b/resources/assets/svg/down-arrow.svg @@ -0,0 +1,3 @@ + + + diff --git a/resources/assets/svg/social/facebook.svg b/resources/assets/svg/social/facebook.svg new file mode 100644 index 0000000..955ae05 --- /dev/null +++ b/resources/assets/svg/social/facebook.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/resources/assets/svg/social/github.svg b/resources/assets/svg/social/github.svg new file mode 100644 index 0000000..8f20dd1 --- /dev/null +++ b/resources/assets/svg/social/github.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/resources/assets/svg/social/instagram.svg b/resources/assets/svg/social/instagram.svg new file mode 100644 index 0000000..5bc4e0f --- /dev/null +++ b/resources/assets/svg/social/instagram.svg @@ -0,0 +1,4 @@ + + + + diff --git a/resources/assets/svg/social/linkedin.svg b/resources/assets/svg/social/linkedin.svg new file mode 100644 index 0000000..c528de7 --- /dev/null +++ b/resources/assets/svg/social/linkedin.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/resources/assets/svg/social/reddit.svg b/resources/assets/svg/social/reddit.svg new file mode 100644 index 0000000..fe51986 --- /dev/null +++ b/resources/assets/svg/social/reddit.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/resources/assets/svg/social/twitter.svg b/resources/assets/svg/social/twitter.svg new file mode 100644 index 0000000..ee21ec0 --- /dev/null +++ b/resources/assets/svg/social/twitter.svg @@ -0,0 +1,4 @@ + + + + diff --git a/resources/assets/svg/social/x-twitter.svg b/resources/assets/svg/social/x-twitter.svg new file mode 100644 index 0000000..37602cf --- /dev/null +++ b/resources/assets/svg/social/x-twitter.svg @@ -0,0 +1,18 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/resources/main.html b/resources/main.html index 338edb6..fd68d88 100644 --- a/resources/main.html +++ b/resources/main.html @@ -1,12 +1,16 @@ {% extends "base.html" %} +{% block header %} +{% include "partials/header.html" %} +{% endblock %} + {% block footer %} -

Copyright © 2024 Stakater AB – Change cookie settings

+{% include "partials/footer.html" %} {% endblock %} {% block outdated %} - You're not viewing the latest version. - - Click here to go to latest. - -{% endblock %} +You're not viewing the latest version. + + Click here to go to latest. + +{% endblock %} \ No newline at end of file diff --git a/resources/partials/footer.html b/resources/partials/footer.html new file mode 100644 index 0000000..42d7936 --- /dev/null +++ b/resources/partials/footer.html @@ -0,0 +1,345 @@ + + + \ No newline at end of file diff --git a/resources/partials/header.html b/resources/partials/header.html new file mode 100644 index 0000000..3233199 --- /dev/null +++ b/resources/partials/header.html @@ -0,0 +1,162 @@ +{% set class = "md-header" %} +{% if "navigation.tabs.sticky" in features %} +{% set class = class ~ " md-header--shadow md-header--lifted" %} +{% elif "navigation.tabs" not in features %} +{% set class = class ~ " md-header--shadow" %} +{% endif %} + + + + +
+ + + + {% if "navigation.tabs.sticky" in features %} + {% if "navigation.tabs" in features %} + + {% endif %} + {% endif %} +
+ + + \ No newline at end of file diff --git a/resources/partials/javascripts/nav-links.html b/resources/partials/javascripts/nav-links.html new file mode 100644 index 0000000..174d153 --- /dev/null +++ b/resources/partials/javascripts/nav-links.html @@ -0,0 +1,251 @@ + \ No newline at end of file diff --git a/resources/partials/javascripts/palette.html b/resources/partials/javascripts/palette.html new file mode 100644 index 0000000..0fcb396 --- /dev/null +++ b/resources/partials/javascripts/palette.html @@ -0,0 +1,24 @@ + \ No newline at end of file diff --git a/resources/partials/nav-links.html b/resources/partials/nav-links.html new file mode 100644 index 0000000..0987567 --- /dev/null +++ b/resources/partials/nav-links.html @@ -0,0 +1,241 @@ + + + + + +{% include "partials/javascripts/nav-links.html" %} \ No newline at end of file diff --git a/resources/partials/palette.html b/resources/partials/palette.html new file mode 100644 index 0000000..67bd00d --- /dev/null +++ b/resources/partials/palette.html @@ -0,0 +1,25 @@ + + + + +
+ {% for option in config.theme.palette %} + {% set scheme = option.scheme | d("default", true) %} + {% set primary = option.primary | d("indigo", true) %} + {% set accent = option.accent | d("indigo", true) %} + + {% if option.toggle %} + + {% endif %} + {% endfor %} +
\ No newline at end of file diff --git a/resources/stylesheets/extra.css b/resources/stylesheets/extra.css index 54f9cee..8e79e68 100644 --- a/resources/stylesheets/extra.css +++ b/resources/stylesheets/extra.css @@ -15,16 +15,40 @@ .md-typeset .note>.admonition-title, .md-typeset .note>summary { background-color: #ef7c3030; } + /* search results 'see more' text */ .md-search-result__more>summary>div { color: #EF7C30; } + .md-search { + width: auto; + } + .md-search__form { + background-color: transparent; + border-radius: 6px; + border: 1px solid rgba(23, 25, 28, 0.4); + } + .md-search__input { + width: 100%; + } + .md-search__inner { + width: 8rem; + } /* font weights for headings*/ .md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5, .md-typeset h6 { font-weight: 600; } + + .md-nav__title { + font-size: 0.8rem; + } + .md-nav__link { + font-size: 0.8rem; + } } + + [data-md-color-scheme="slate"] { /* --md-primary-fg-color: black; */ --md-primary-fg-color: #EF7C30; @@ -46,8 +70,100 @@ color: #FFFFFF; } + --md-typeset-color: rgba(255, 255, 255, 0.8); --md-typeset-a-color: #FF7500; + + /* pre-defined classes */ + .md-search__input::placeholder { + color: rgba(255, 255, 255, 0.8); + } + .md-search__form { + border: 1px solid rgba(255, 255, 255, 0.8); + } + .search-magnify { + stroke: #fff; + stroke-width: 2; + } + .md-search__icon { + color: rgba(255, 255, 255, 0.8); + } + .md-search__input { + color: #fff; + } + + .md-header { + border-bottom: 1px solid rgba(255, 255, 255, 0.4); + } + .md-header__topic{ + display: flex; + justify-content: center; + align-items: center; + } + .md-version { + border: 1px solid rgba(255, 255, 255, 0.8); + border-radius: 6px; + display: flex; + justify-content: center; + align-items: center; + margin: 0 3rem; + height: 32px; + width: 4rem; + } + .md-version__current { + color: #fff; + margin: 1rem; + } + + /* custom classes */ + .custom-anchor { + color: rgba(255, 255, 255, 0.8); + } + + .dropdown-menu { + background-color: #131414; + filter: drop-shadow(0 0 8px rgba(255, 255, 255, 0.3)); + border-radius: 8px; + } + + .down-arrow { + fill: rgba(255, 255, 255, 0.8); + } + .down-arrow:hover { + fill: #EF7C30; + } + .dropdown-item-link-text { + color: white; + cursor: pointer; + font-size: 14px; + font-weight: 400; + } + + + .md-footer{ + background-color: #131414; + border-top: 1px solid rgba(255, 255, 255, 0.1); + margin-top: 2rem + } + .md-footer-col-title { + font-size: 14px; font-weight: 400; color: #fff; + } + .md-footer-col-link { + width: fit-content; font-size: 12px; color: #fff; cursor: pointer; + } + .md-footer-col-link:hover{ + text-decoration: underline; + } + .md-footer-org-details-md { + width: fit-content; font-size: 12px; color: #fff; + } + .md-footer-base-content { + width: fit-content; font-size: 11px; text-decoration: underline; cursor: pointer; color: #fff; + } + + .vertical-divider { + margin: 0 1rem; display: flex; align-items: center; cursor: none; color: #fff; + } } [data-md-color-scheme="default"] { @@ -62,7 +178,7 @@ /*sidebar heading title*/ --md-default-fg-color--light: rgba(0, 0, 0, 0.837); /*default heading color*/ - .md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5, .md-typeset h6 { + .md-typeset h1, .md-typeset h2, .md-typeset h3, .md-typeset h4, .md-typeset h5, .md-typeset h6 { color: rgba(0, 0, 0, 0.837); } /*to change the header bar text to black*/ @@ -72,4 +188,94 @@ --md-typeset-color: rgba(0, 0, 0, 0.8); --md-typeset-a-color: #EF7C30; + + /* pre-defined classes */ + .md-search__input::placeholder { + color: rgba(23, 25, 28, 0.4); /* #17191C; */ + } + .md-search__form { + border: 1px solid rgba(23, 25, 28, 0.4); + } + .search-magnify { + stroke: #282523; + stroke-width: 2; + } + .md-search__icon{ + color: #282523; + } + .md-search__input { + color: #282523; + } + + .md-header { + border-bottom: 1px solid rgba(23, 25, 28, 0.2); + } + .md-header__topic{ + display: flex; + justify-content: center; + align-items: center; + } + .md-version { + border: 1px solid rgba(23, 25, 28, 0.8); + border-radius: 6px; + display: flex; + justify-content: center; + align-items: center; + margin: 0 3rem; + height: 32px; + width: 4rem; + } + .md-version__current { + color: #282523; + margin: 1rem; + } + + /* custom classes */ + .custom-anchor { + color: rgba(0, 0, 0, 0.837); + } + + .dropdown-menu { + background-color: white; + } + + .down-arrow { + fill: rgba(0, 0, 0, 0.837); + } + .down-arrow:hover { + fill: #EF7C30; + } + .dropdown-item-link-text { + color: black; + cursor: pointer; + font-size: 14px; + font-weight: 400; + } + + + + .md-footer{ + background-color: white; + border-top: 1px solid rgba(0, 0, 0, 0.2); + margin-top: 2rem + } + .md-footer-col-title { + font-size: 14px; font-weight: 400; color: black; + } + .md-footer-col-link { + width: fit-content; font-size: 12px; color: black; cursor: pointer; + } + .md-footer-col-link:hover{ + text-decoration: underline; + } + .md-footer-org-details-md { + width: fit-content; font-size: 12px; color: black + } + .md-footer-base-content { + width: fit-content; font-size: 11px; text-decoration: underline; cursor: pointer; color: black; + } + + .vertical-divider { + margin: 0 1rem; display: flex; align-items: center; cursor: none; color: black; + } } \ No newline at end of file