customization

lifeblood tries hard to provide sensible defaults, but it also ships with a number of CSS variables and customization options should your site need them.

CSS variables

these can be placed in your site’s custom stylesheet under a standard :root rule.

colors

elements

syntax highlighting tokens

fonts

overrides

site options

these should go in your _config.yml.

home

type: string

the path to your documentation’s front page; for example, victus uses /docs.
this will be used in the navigation.
useful for project sites which serve an index.html page separate from the project’s documentation.

used to sort the navigation into multiple categories.
see the navigation page for more information.

type: string

content to show in the left half of the site footer.

type: string

content to show in the right half of the site footer.

theme_color

type: string

value to use for the theme-color meta tag.

enable_custom

type: boolean

if true, the contents of the file assets/custom.scss will be loaded after all other styles.
make sure to begin the file with an empty YAML front matter block (two lines with three dashes each).

fonts

type: array

an array of fonts to load from Google Fonts.
each item should match what is found after the family URL parameter of the font, e.g. Nunito+Sans or Rubik:wght@300;600.

if done correctly, you’ll be able to use the loaded fonts as overrides.

enable_dark_theme

type: boolean

if true, a dark theme will be used on devices which express a preference.

enable_versions

type: boolean

if true, the navigation will change to allow for multiple versions of documentation.
see the navigation page for more information.