Config
Defines the primary configuration for the entire site. In Toucan, these settings are specified in the config.yml file located in the project’s root directory. This file is optional; if it is not present, Toucan will automatically fall back to the default configuration values.
Default Configuration
The default configuration values are as follows:
pipelines:
path: pipelines
contents:
path: contents
assets:
path: assets
themes:
location:
path: themes
current:
path: default
assets:
path: assets
templates:
path: templates
types:
path: types
overrides:
path: overrides
blocks:
path: blocks
dateFormats:
input:
format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
output: {}
contentConfigurations:
wordsPerMinute: 238
outlineLevels:
- 2
- 3
paragraphStyles:
note:
- note
warn:
- warn
- warning
tip:
- tip
important:
- important
error:
- error
- caution
Pipelines
The location of the render pipelines.
pipelines.path - The location of the pipelines folder.
This value specifies the location of the pipelines folder inside the source folder.
Contents
The location of the contents.
contents.path - The location of the contents folder.
This value specifies the location of the contents folder inside the source folder.
contents.assets.path - The location of the assets within the content bundle.
This value specifies the location of the assets inside a content bundle.
Themes section
This section defines the location of the theme-related files and other theme-related settings, such as the theme to use.
themes.location.path - The location of the themes folder.
This value specifies the location of the themes folder inside the source folder.
themes.current.path - The theme to use.
This value specifies the folder name of the theme, inside the themes folder, to use.
themes.assets.path - The name of the assets folder.
This value specifies the folder name of the assets location inside the theme folder.
themes.templates.path - The name of the templates folder.
This value specifies the folder name of the Mustache templates location inside the theme folder.
themes.overrides.path - The name of the template overrides folder.
This value specifies the folder name of the Mustache template overrides location inside the theme folder. If you place a file in this folder, it will override the default template for the corresponding file.
themes.types.path - The name of the content types folder.
This value specifies the folder name of the content types location inside the theme folder. This folder is used to define custom content types for the website.
themes.blocks.path - The name of the blocks folder.
This value specifies the folder name of the blocks location inside the theme folder.
Date Formats
This section defines the input and output date formats for the website.
dateFormats.input.format - The input date format.
This value specifies the format in which dates are expected to be provided in the content files.
Example
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
dateFormats.output - The output date format.
This value specifies the format in which dates are displayed on the site. If left empty, the default format will be used.
Content Configurations
This section defines additional configurations for content processing.
contentConfigurations.wordsPerMinute - The average words per minute for reading time calculations.
This value specifies the number of words per minute used to estimate reading time for content.
contentConfigurations.outlineLevels - The heading levels included in the content outline.
This value specifies the heading levels (e.g., H2, H3) that are included in the content outline.
contentConfigurations.paragraphStyles - The styles applied to paragraphs.
This value specifies the mapping of paragraph styles to their corresponding keywords (e.g., note, warn, tip).