diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/_extensions/fnl/__init__.py b/_extensions/fnl/__init__.py new file mode 100644 index 0000000..7df2feb --- /dev/null +++ b/_extensions/fnl/__init__.py @@ -0,0 +1,20 @@ +""" +Quarto HTML format with FNL branding guidelines + +First run `ccbr_tools quarto-add fnl`, then modify the `_quarto.yml` file with the following: + +```yaml +website: + ... + page-footer: + background: black + foreground: white + left: | + [![](/_extensions/fnl/fnl-logo-dark.png){height=70px}](https://frederick.cancer.gov/research/science-areas/bioinformatics-and-computational-science/advanced-biomedical-computational-science) + center: | + Created by the + [CCR Collaborative Bioinformatics Resource](https://github.com/CCBR) + +format: fnl-html +``` +""" diff --git a/_extensions/fnl/_extension.yml b/_extensions/fnl/_extension.yml new file mode 100644 index 0000000..894dd1c --- /dev/null +++ b/_extensions/fnl/_extension.yml @@ -0,0 +1,12 @@ +title: fnl +author: Kelly Sovacool +version: 0.1.3 +quarto-required: ">=1.5.0" +contributes: + formats: + html: + theme: + dark: [darkly, fnl-dark.scss] + light: [flatly, fnl-light.scss] + toc: true + code-fold: show diff --git a/_extensions/fnl/fnl-dark.scss b/_extensions/fnl/fnl-dark.scss new file mode 100644 index 0000000..7d32586 --- /dev/null +++ b/_extensions/fnl/fnl-dark.scss @@ -0,0 +1,48 @@ +// override select variables from fnl-light.scss +/*-- scss:defaults --*/ + +// branding guidelines +// https://nih.sharepoint.com/:b:/r/sites/NCI-Fred/Communications/Shared%20Documents/Branding%20guidelines%20LIVE.pdf?csf=1&web=1&e=e9PrVO + +// primary colors +$black: #000000; +$white: #ffffff; +$lime: #7cc349; +$teal: #296b7f; + +//secondary colors +$teal-light: #4e9db5; +$teal-dark: #19424e; +$almost-black: #03191f; +$lime-light: #b1ee85; +$lime-dark: #528230; +$orange: #ecba4c; + +// set colors +$primary: $teal; +$secondary: $lime; + +$body-bg: $almost-black; +$link-color: $lime; + +$navbar-bg: $teal-dark; +$navbar-hl: $lime-light; +$footer-bg: $black; +$footer-fg: $white; +$footer-hl: $lime-light; +$sidebar-hl: $lime-light; + +$code-block-bg-alpha: -0.8; +$code-bg-alpha: -0.8; +$code-alpha: 0.9; +$code-bg: $teal-dark; +$code-color: $orange; + +$callout-color-tip: $lime; +$callout-color-note: $teal-light; +$callout-color-caution: $orange; +$callout-color-warning: $orange; + +// font +$font-family-sans-serif: "Roboto", sans-serif; +$font-family-monospace: "Roboto Mono", monospace; diff --git a/_extensions/fnl/fnl-light.scss b/_extensions/fnl/fnl-light.scss new file mode 100644 index 0000000..a27a325 --- /dev/null +++ b/_extensions/fnl/fnl-light.scss @@ -0,0 +1,41 @@ +/*-- scss:defaults --*/ + +// branding guidelines +// https://nih.sharepoint.com/:b:/r/sites/NCI-Fred/Communications/Shared%20Documents/Branding%20guidelines%20LIVE.pdf?csf=1&web=1&e=e9PrVO + +// primary colors +$black: #000000; +$white: #ffffff; +$lime: #7cc349; +$teal: #296b7f; + +//secondary colors +$teal-light: #4e9db5; +$teal-dark: #19424e; +$almost-black: #03191f; +$lime-light: #b1ee85; +$lime-dark: #528230; +$orange: #ecba4c; + +// set colors +$primary: $teal-dark; +$secondary: $lime; +$success: $lime-dark; +$warning: $orange; +$info: $teal-light; + +$link-color: $teal; + +$footer-bg: $black; +$footer-fg: $white; + +$code-color: $lime-dark; + +$callout-color-tip: $lime-dark; +$callout-color-note: $teal-light; +$callout-color-caution: $orange; +$callout-color-warning: $orange; + +// font +$font-family-sans-serif: "Roboto", sans-serif; +$font-family-monospace: "Roboto Mono", monospace; diff --git a/_extensions/fnl/fnl-logo-dark.png b/_extensions/fnl/fnl-logo-dark.png new file mode 100644 index 0000000..d9b9c7c Binary files /dev/null and b/_extensions/fnl/fnl-logo-dark.png differ diff --git a/_extensions/fnl/fnl-logo-light.png b/_extensions/fnl/fnl-logo-light.png new file mode 100644 index 0000000..d6eb422 Binary files /dev/null and b/_extensions/fnl/fnl-logo-light.png differ diff --git a/_quarto.yml b/_quarto.yml index 1ced573..0b41178 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -31,18 +31,20 @@ website: file: .github/CONTRIBUTING.md - text: Changelog file: CHANGELOG.md + - text: License + file: LICENSE.md - icon: github href: https://github.com/CCBR/nf-modules + page-footer: + background: black + foreground: white left: | + [![](/_extensions/fnl/fnl-logo-dark.png){height=70px}](https://frederick.cancer.gov/research/science-areas/bioinformatics-and-computational-science/advanced-biomedical-computational-science) + center: | Created by the [CCR Collaborative Bioinformatics Resource](https://github.com/CCBR) execute: freeze: auto -format: - html: - theme: - dark: solar - light: yeti - embed-resources: true +format: fnl-html