Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document custom logo #197

Merged
merged 6 commits into from
Jul 26, 2024
Merged

document custom logo #197

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2cfc79a
document custom logo
ErinBecker Jun 21, 2024
dbacfa0
Update episodes/editing.md
ErinBecker Jun 24, 2024
cafce5b
Update episodes/editing.md
ErinBecker Jun 24, 2024
a6711d7
Update episodes/editing.md
ErinBecker Jun 24, 2024
ea7e047
Add carpentry_description documentation
ErinBecker Jun 25, 2024
3376f44
expand list of options for value of carpentry
tobyhodges Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions episodes/editing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,24 @@ These fields will be simple key-pair values of information used throughout the e
carpentry
: The code for the specific carpentry that the lesson belongs to (swc, dc, lc, cp)

carpentry_description
: (Optional) Full organisation name. Not needed when carpentry is swc, dc, lc, or cp.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
carpentry_description
: (Optional) Full organisation name. Not needed when carpentry is swc, dc, lc, or cp.
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

Expand Down
Loading