Configure your site
The basic settings and configuration for your site reside in the _config.yaml
file.
Example:
Parameter | Description | Default |
---|---|---|
| Title of your site. Appears in the tab title, in the header, and in page metadata. Use a short version of your lab's name if you have one so it can fit nicely in these spots. Aim for less than 20 characters. Tip: If your lab name is long, use an abbreviated version here, then display the full name at the top of your homepage. | |
| Appears in the header next to your site title, smaller and more subtle. Useful for slogans or affiliations. | |
| Default description that will show under search engine results. Can be overridden on individual pages. | |
| Whether to show your site title/subtitle next to your logo in the header. Set to |
|
| Default background image for the header/footer. Can be overridden on individual pages. | Solid color background |
| Default header/footer dark/light mode. Can be overridden on individual pages. |
|
| Social media links for your lab to show in the footer of every page, without any prefixes like | |
| 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. |
|
Headers/footers/sections have a solid color that overlays any background image to always maintain readability of text.
Last updated