Merge pull request #20 from nhs-r-community/corrections

Corrections
nhs-r-community · Nov 26, 2024 · 586a658 · 586a658
2 parents 5daf991 + 9632282
commit 586a658
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 5 deletions.
diff --git a/brand/README.md b/brand/README.md
@@ -0,0 +1,50 @@
+# brand.yml
+
+Following Posit's addition of a [`_brand.yml` file](https://posit-dev.github.io/brand-yml/) 
+to help with applying consistent branding across Quarto, Python or R we have set
+this up for NHS-R Community branding.
+
+NHS-R Community uses NHS England colours for its slides and books.
+Details are in the [branding chapter](https://nhsrway.nhsrcommunity.com/style-guides.html#branding)
+of NHS-R Way.
+
+Whilst the NHS blues are the most familiar, NHS-R Community often uses the 
+highlight colours.
+
+Although NHS England has possibly checked the accessibility of colours we advise
+that you always consider the contrast combination when using the colours and 
+check any outputs.
+
+## Logo
+
+If you need to use the NHS-R Community logo (or wish to use another like NHS for
+any official outputs) you will need to remove the comment hashes from the 
+`_brand_yml` file and ensure that the logo file is saved wherever the `_brand.yml`
+file is.
+
+The NHS-R Community logos can be found in the 
+[folder `logo`](https://github.com/nhs-r-community/assets/tree/main/logo) in 
+this GitHub repository.
+
+If you'd prefer to link directly using a url, this currently isn't possible to 
+do through the `_brand.yml` file but for Quarto can be added to the `_quarto.yml`
+file as:
+
+```
+# For presentations
+format:
+  revealjs:
+  logo: https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg
+```
+
+## Quarto
+
+If you are using a Quarto file `_quarto.yml` within a Quarto project (an example
+being the [NHS-R Community presentations](https://github.com/nhs-r-community/NHSR-presentations/blob/main/_quarto.yml) 
+which each refer to this file for shared attributes you will need to add the code:
+
+```
+brand: _brand.yml
+```
+
+to apply the branding.
diff --git a/brand/_brand.yml b/brand/_brand.yml
@@ -10,6 +10,7 @@ meta:
 # logo:
 #   images:
 #     header: nhsr-logo.svg
+#   small: nhsr-logo.svg
 #   medium: header
 #   large: header
 

diff --git a/logo/README.md b/logo/README.md
@@ -4,15 +4,19 @@ This repository has two version of the NHS-R Community logo, `png` and `svg`.
 
 Each can be linked to generally in code using html and we highly recommend including this code in its entirety for the inclusion of the alt text:
 
-Use code like:
+Use html code:
 
+```         
+<a alt="NHS-R Community" href='https://nhsrcommunity.com/'><img src='https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg' align="center" height="80" /></a>
 ```
-<a alt="NHS-R Community's logo" href='https://nhsrcommunity.com/'><img src='https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg' align="right" height="80" /></a>
-```
 
-Rendered:
+or using markdown:
+
+```
+![](https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg){align="center" alt="NHS-R Community" height="80"}
+```
 
-<a alt="NHS-R Community's logo" href='https://nhsrcommunity.com/'><img src='https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg' align="right" height="80" /></a>
+![](https://raw.githubusercontent.com/nhs-r-community/assets/main/logo/nhsr-logo.svg){align="center" alt="NHS-R Community" height="80"}
 
 ## Branding