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.

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
Changes from 1 commit
Commits
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
13 changes: 13 additions & 0 deletions episodes/editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,19 @@ 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)

::::::::::: 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 organisation's logo by
ErinBecker marked this conversation as resolved.
Show resolved Hide resolved

1. Adding your organisation's logo file (e.g. 'ice-cream-logo.svg') to your fork of `varnish` in the `inst/pkgdown/assets/assets/images` folder.
ErinBecker marked this conversation as resolved.
Show resolved Hide resolved
1. Setting `carpentry` to match the name of your logo file. (e.g. 'ice-cream')
ErinBecker marked this conversation as resolved.
Show resolved Hide resolved
1. Adding 'varnish: [YOUR-GITHUB-USERNAME]/varnish' to the Customization section of your lessons `config.yaml` file.

:::::::::::::::::::


title
: The main title of the lesson

Expand Down
Loading