differences for PR #197

carpentries · Jul 26, 2024 · 8f58308 · 8f58308
1 parent 4c61b7d
commit 8f58308
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/editing.md b/editing.md
@@ -140,7 +140,25 @@ and organization
 These fields will be simple key-pair values of information used throughout the episode
 
 carpentry
-: The code for the specific carpentry that the lesson belongs to (swc, dc, lc, cp)
+: The code for the specific carpentry that the lesson belongs to (swc, dc, lc, cp, incubator, lab)
+
+carpentry_description
+: (Optional) Full organisation name. Not needed when carpentry is swc, dc, lc, cp, incubator, or lab. 
+
+::::::::::: callout
+
+### Adding a custom logo
+
+The "carpentry" variable works with the {varnish} package to control the logo displayed on your lesson. You can display your own logo by
+
+1. Adding the logo file as SVG (e.g. 'ice-cream-logo.svg') to your fork of {varnish} in the `inst/pkgdown/assets/assets/images` folder. 
+1. Setting "carpentry" to match the beginning of the name of your logo file. E.g. to use the `ice-cream-logo.svg` file given above, "carpentry" should be set to 'ice-cream'.
+1. Adding 'varnish: [YOUR-GITHUB-USERNAME]/varnish' to the Customization section of your lessons `config.yaml` file.
+
+The rendered lesson will display your logo file with alternative text that matches the value of "carpentry". For more informative alternative text, you can set "carpentry_description" to your organisation's full name. E.g. "Ice Cream Carpentry" instead of "ice-cream". 
+
+:::::::::::::::::::
+
 
 title
 : The main title of the lesson

diff --git a/md5sum.txt b/md5sum.txt
@@ -6,7 +6,7 @@
 "links.md" "a7ea11385a9d821b8f57edb0951c83ca" "site/built/links.md" "2024-07-02"
 "episodes/introduction.md" "b1ca0d51bfee1538beabc08f46b389cf" "site/built/introduction.md" "2024-07-02"
 "episodes/episodes.Rmd" "4f9401544dcfcd6d0ba5b61dca806f04" "site/built/episodes.md" "2024-07-02"
-"episodes/editing.md" "51d14a223e1a4603e1224d0e624d06dd" "site/built/editing.md" "2024-07-02"
+"episodes/editing.md" "7b5d6a45cfe297d06bf61326bea97251" "site/built/editing.md" "2024-07-26"
 "episodes/example.Rmd" "215e3c4ed500fef3410f040349fb0a73" "site/built/example.md" "2024-07-02"
 "episodes/deployment.md" "f15377cac190ef5435a60d074aa8aeb3" "site/built/deployment.md" "2024-07-02"
 "episodes/update.md" "e3939117fb9b893806c4f43e7f08594e" "site/built/update.md" "2024-07-02"