The basic settings and configuration for your site reside in the _config.yaml file.
Example:
### basic settings
# site properties and page defaults
title: Lab Website Template
subtitle: A template by the Greene Lab
description: An easy-to-use, flexible website template for labs, with automatic citations, GitHub tag imports, pre-built components, and more.
logo-text: false
header: images/background.jpg
footer: images/background.jpg
header-dark: false
footer-dark: false
proofer: false
# site social media and other links
links:
email: [email protected]
orcid: 0000-0001-8713-9213
google-scholar: ETJoidYAAAAJ
github: your-lab
twitter: YourLabHandle
instagram: YourLabHandle
youtube: YourLabChannel
### Jekyll settings to ignore
...| Parameter | Description | Default |
|---|---|---|
title | Title of your site. Appears in the tab title, in the header, and in page metadata. Tip: If your lab name is long, use an abbreviated version here, then display the full name at the top of your homepage. | |
subtitle | Appears in the header next to your site title, smaller and more subtle. Useful for slogans or affiliations. | |
description | Default description that will show under search engine results. Can be overridden on individual pages. | |
show-title / show-subtitle | Whether to show your site title/subtitle next to your logo in the header. Set to false if your logo image already contains text that you don't want to be displayed twice. This does not remove your site title from the tab name, metadata, or anything else. | true |
header / footer | Default background image for the header/footer. Can be overridden on individual pages. | Solid color background |
header-dark / footer-dark | Default header/footer dark/light mode. Can be overridden on individual pages. | true |
links | Social media links for your lab to show in the footer of every page, without any prefixes like @, www., etc.See /_data/types.yaml for what types of links are built-in or to add your own. | |
proofer | Whether to use html-proofer to check your site for broken links, images, and more. If broken items are found, a warning is shown in your Actions workflow logs or your console. It is not a critical error that will prevent your site from building, because it is not perfect: there can be false positives/negatives. It is disabled by default because it can add quite a bit of time to updating/building your remote or local previews. | false |
{% hint style="info" %} Headers/footers/sections have a solid color that overlays any background image to always maintain readability of text. {% endhint %}