From cebaaf6fefdb66a6a9876e857dcbab18c4d16786 Mon Sep 17 00:00:00 2001 From: edavidaja Date: Tue, 7 May 2024 13:12:35 -0400 Subject: [PATCH] updated posit-docs extension --- _environment | 2 + .../posit-dev/posit-docs/_extension.yml | 49 +++---- .../posit-docs/assets/_analytics.html | 40 ++++++ .../assets/images/posit-guide-dm.svg | 1 + .../assets/images/posit-guide-ltmd.svg | 1 + .../assets/images/posit-guide-open-dm.svg | 1 + .../assets/images/posit-guide-open-ltmd.svg | 1 + .../assets/images/posit-logo-black-TM.svg | 2 +- _extensions/posit-dev/posit-docs/theme.scss | 121 +++++++++++++++++- _quarto.yml | 32 ++++- images/favicon.svg | 21 +++ images/posit-guide-dm.svg | 1 + images/posit-guide-ltmd.svg | 1 + images/posit-guide-open-dm.svg | 1 + images/posit-guide-open-ltmd.svg | 1 + images/posit-icon-fullcolor.svg | 22 ++++ images/posit-logo-black-TM.svg | 1 + images/posit-logo-fullcolor-TM.svg | 1 + 18 files changed, 256 insertions(+), 43 deletions(-) create mode 100644 _environment create mode 100644 _extensions/posit-dev/posit-docs/assets/_analytics.html create mode 100644 _extensions/posit-dev/posit-docs/assets/images/posit-guide-dm.svg create mode 100644 _extensions/posit-dev/posit-docs/assets/images/posit-guide-ltmd.svg create mode 100644 _extensions/posit-dev/posit-docs/assets/images/posit-guide-open-dm.svg create mode 100644 _extensions/posit-dev/posit-docs/assets/images/posit-guide-open-ltmd.svg create mode 100644 images/favicon.svg create mode 100644 images/posit-guide-dm.svg create mode 100644 images/posit-guide-ltmd.svg create mode 100644 images/posit-guide-open-dm.svg create mode 100644 images/posit-guide-open-ltmd.svg create mode 100644 images/posit-icon-fullcolor.svg create mode 100644 images/posit-logo-black-TM.svg create mode 100644 images/posit-logo-fullcolor-TM.svg diff --git a/_environment b/_environment new file mode 100644 index 00000000..3f26336d --- /dev/null +++ b/_environment @@ -0,0 +1,2 @@ +CURRENT_YEAR=2024 +PRODUCT_VERSION=2024.x diff --git a/_extensions/posit-dev/posit-docs/_extension.yml b/_extensions/posit-dev/posit-docs/_extension.yml index 4b25a124..5e7f0b4d 100644 --- a/_extensions/posit-dev/posit-docs/_extension.yml +++ b/_extensions/posit-dev/posit-docs/_extension.yml @@ -1,42 +1,33 @@ title: posit-docs -author: Ashley Henry -version: 0.2.0 -quarto-requred: ">=1.3.340" +author: Ashley Henry, David Aja, Aron Atkins +version: 3.0.0 +quarto-required: ">=1.3.340" contributes: project: project: type: website website: - title: favicon: "assets/images/favicon.svg" bread-crumbs: true navbar: pinned: true logo: "assets/images/posit-icon-fullcolor.svg" logo-alt: "Posit Documentation" - sidebar: - style: "floating" - collapse-level: 1 - search: true - pinned: false - page-footer: - left: - - text: © 2024 Posit Software, PBC - url: "https://posit.co" - center: | - Posit Product 12345 - right: - - icon: book - href: https://docs.posit.co - - icon: question-circle-fill - href: https://support.posit.co/hc/en-us - - icon: lightbulb-fill - href: https://solutions.posit.co - formats: - html: - theme: [theme.scss] - link-external-icon: true - link-external-newwindow: true - toc: true - toc-expand: true + - icon: "list" + menu: + - text: "docs.posit.co" + href: "https://docs.posit.co" + - text: "Posit Support" + href: "https://support.posit.co/hc/en-us/" + search: + copy-button: true + show-item-context: true + format: + html: + theme: [theme.scss] + link-external-icon: true + link-external-newwindow: true + toc: true + toc-expand: true + include-in-header: "assets/_analytics.html" diff --git a/_extensions/posit-dev/posit-docs/assets/_analytics.html b/_extensions/posit-dev/posit-docs/assets/_analytics.html new file mode 100644 index 00000000..6ba70366 --- /dev/null +++ b/_extensions/posit-dev/posit-docs/assets/_analytics.html @@ -0,0 +1,40 @@ + + diff --git a/_extensions/posit-dev/posit-docs/assets/images/posit-guide-dm.svg b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-dm.svg new file mode 100644 index 00000000..b0c67d11 --- /dev/null +++ b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-dm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_extensions/posit-dev/posit-docs/assets/images/posit-guide-ltmd.svg b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-ltmd.svg new file mode 100644 index 00000000..f2c33c23 --- /dev/null +++ b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-ltmd.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-dm.svg b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-dm.svg new file mode 100644 index 00000000..d6b0e2b2 --- /dev/null +++ b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-dm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-ltmd.svg b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-ltmd.svg new file mode 100644 index 00000000..77464c09 --- /dev/null +++ b/_extensions/posit-dev/posit-docs/assets/images/posit-guide-open-ltmd.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/_extensions/posit-dev/posit-docs/assets/images/posit-logo-black-TM.svg b/_extensions/posit-dev/posit-docs/assets/images/posit-logo-black-TM.svg index b85676de..3b159987 100644 --- a/_extensions/posit-dev/posit-docs/assets/images/posit-logo-black-TM.svg +++ b/_extensions/posit-dev/posit-docs/assets/images/posit-logo-black-TM.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/_extensions/posit-dev/posit-docs/theme.scss b/_extensions/posit-dev/posit-docs/theme.scss index bad2b7b1..418bd8b4 100644 --- a/_extensions/posit-dev/posit-docs/theme.scss +++ b/_extensions/posit-dev/posit-docs/theme.scss @@ -18,6 +18,11 @@ $posit-burgundy-1:#78384F; $posit-burgundy-2:#542938; $primary: $posit-blue; + +// Feature preview heading colors +$preview-header: #EE6331; /* posit orange, contrast: 8.45 */ +$preview-header-border: darken($preview-header, 5%); + // scss-docs-end color-variables // Typography @@ -75,6 +80,26 @@ $list-group-color: $primary !default; font-weight: 500; } +/* Style for the version included in the website title */ +.navbar-title small { + font-size: 14px; + display: block; + padding-left: 1em; +} + +/* Posit logo - navbar or footer */ +#footer-right-posit-logo { + width: 70px; + min-width: 70px; +} + +#footer-right-logo { + width: 20px; + min-width: 20px; + margin-left: -3px !important; + margin-right: -3px !important; +} + .nav-link { font-family: $font-family-monospace; text-transform: uppercase; @@ -98,22 +123,37 @@ $list-group-color: $primary !default; font-family: $font-family-sans-serif; } +/* Sidebar and toc */ + +/* Left nav */ +.sidebar-item-container .active { + font-weight: 500; +} + +/* Left nav - letter spacing */ +.sidebar-navigation li a { + letter-spacing: .03em; + font-size: 16px; +} + /* Mini TOC */ .sidebar nav[role=doc-toc]>ul li a { text-transform: none !important; font-family: $font-family-sans-serif; - font-size: 16px; - font-weight: 300 !important; - letter-spacing: .05em !important; + font-weight: 400 !important; + letter-spacing: -0.2px !important; +} + +.sidebar nav[role=doc-toc] ul>li>a.active, .sidebar nav[role=doc-toc] ul>li>ul>li>a.active { + font-weight: 700 !important; } /* Left nav - letter spacing */ .sidebar-navigation li a { - letter-spacing: .03em; - font-size: 16px; + letter-spacing: -0.2px; + line-height: normal; } - /* Posit logo - footer */ #footer-logo { width: 70px; @@ -125,7 +165,74 @@ $list-group-color: $primary !default; min-height: min-content; } +// Font + +/* Body font */ +body { + letter-spacing: -0.2px !important; + } + +// Specialty headers + +/* the feature PREVIEW header */ +.preview-header > h1:after, +.preview-header > h2:after, +.preview-header > h3:after, +.preview-header > h4:after, +header h1 .preview-header { + content: "Preview feature"; + margin-left: 1em; + position: relative; + border-radius: 50rem !important; + top: -0.5em; +} + +.preview-header > h1:after, +.preview-header > h2:after, +.preview-header > h3:after, +.preview-header > h4:after, +header h1 .preview-header, +div span.preview-feature { + color: $preview-header; + border: 1px solid $preview-header-border; + font-weight: 400; + font-size: 9pt !important; + padding: 0rem 0.4rem; +} + +div span.preview-feature { + margin-left: 1em; + text-transform: uppercase; +} + +// Lists + /* List disc colors */ li::marker { - color: $primary; + color: $primary; +} + +/* Callout steps for images with multiple items/steps shown in single image */ +ol.groovyAlpha { + list-style: none; + counter-reset: list-counter; + } + +ol.groovyAlpha li { + counter-increment: list-counter; +} + +ol.groovyAlpha li > p:before { + content: counter(list-counter, lower-alpha); + width: 16px; + height: 16px; + text-align: center; + margin-right: 10px; + color: #fff; + background-color: #fc403b; + display: inline-block; + border-radius: 8px; + font-size: 9px; + line-height: 16px; + vertical-align: middle; } diff --git a/_quarto.yml b/_quarto.yml index 3f2c9fa6..11cd7a54 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -1,5 +1,8 @@ project: type: posit-docs + pre-render: | + ./helm-docs --chart-search-root=charts --template-files=README.md.gotmpl --template-files=./_templates.gotmpl + ./helm-docs --chart-search-root=other-charts --template-files=README.md.gotmpl --template-files=./_templates.gotmpl render: - charts/rstudio-workbench/README.md - charts/rstudio-workbench/NEWS.md @@ -19,17 +22,34 @@ project: filters: - include-code-files -format: - posit-docs-html: - toc: true - website: title: Posit Helm Charts + site-url: https://docs.posit.co/helm bread-crumbs: true repo-url: https://github.com/rstudio/helm repo-actions: [edit, issue] - page-footer: - center: Posit Helm Charts + page-footer: + left: | + Copyright © 2000-{{< env CURRENT_YEAR >}} Posit Software, PBC. All Rights Reserved. + center: | + Posit Helm Charts {{< env PRODUCT_VERSION >}} + right: + - icon: question-circle-fill + href: "https://support.posit.co/hc/en-us" + - icon: lightbulb-fill + href: "https://solutions.posit.co/" + - text: "" + href: "https://docs.posit.co/" + - text: "" + href: "https://posit.co/" + navbar: + right: + - icon: "list" + menu: + - text: "docs.posit.co" + href: "https://docs.posit.co" + - text: "Posit Support" + href: "https://support.posit.co/hc/en-us/" sidebar: style: "floating" collapse-level: 1 diff --git a/images/favicon.svg b/images/favicon.svg new file mode 100644 index 00000000..d154019f --- /dev/null +++ b/images/favicon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + diff --git a/images/posit-guide-dm.svg b/images/posit-guide-dm.svg new file mode 100644 index 00000000..b0c67d11 --- /dev/null +++ b/images/posit-guide-dm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/posit-guide-ltmd.svg b/images/posit-guide-ltmd.svg new file mode 100644 index 00000000..f2c33c23 --- /dev/null +++ b/images/posit-guide-ltmd.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/posit-guide-open-dm.svg b/images/posit-guide-open-dm.svg new file mode 100644 index 00000000..d6b0e2b2 --- /dev/null +++ b/images/posit-guide-open-dm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/posit-guide-open-ltmd.svg b/images/posit-guide-open-ltmd.svg new file mode 100644 index 00000000..77464c09 --- /dev/null +++ b/images/posit-guide-open-ltmd.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/posit-icon-fullcolor.svg b/images/posit-icon-fullcolor.svg new file mode 100644 index 00000000..ec7f5525 --- /dev/null +++ b/images/posit-icon-fullcolor.svg @@ -0,0 +1,22 @@ + + + + + + diff --git a/images/posit-logo-black-TM.svg b/images/posit-logo-black-TM.svg new file mode 100644 index 00000000..3b159987 --- /dev/null +++ b/images/posit-logo-black-TM.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/posit-logo-fullcolor-TM.svg b/images/posit-logo-fullcolor-TM.svg new file mode 100644 index 00000000..30512e6b --- /dev/null +++ b/images/posit-logo-fullcolor-TM.svg @@ -0,0 +1 @@ + \ No newline at end of file