Config File
_cobalt.yml
let's you specify site-wide options as well as defaults for pages.
Default _cobalt.yml
:
# Build options source: "." template_extensions: - md - liquid include_drafts: false ignore: destination: _site # Site options site: title: ~ description: ~ base_url: ~ data: ~ # Page/Post options default: excerpt_separator: "\n\n" is_draft: false syntax_highlight: theme: "base16-ocean.dark" assets: sass: style: Nested pages: default: {} posts: title: ~ description: ~ dir: posts drafts_dir: _drafts order: Desc rss: ~ jsonfeed: ~ default: {}
Build options
Setting | Format | Description |
---|---|---|
source | String | Directory, relative to _cobalt.yml , where content lives. |
template_extensions | List of Strings | File extensions that mark a file as a page as compared to an asset. |
include_drafts | Boolean | Specifies whether marks marked is_draft should be generated by default. This can be overriden with command line flags. |
ignore | List of Strings | Specifies what files should be ignored by Cobalt by way of a list of gitignore patterns for, relative to source . |
destination | String | Directory, relative to _cobalt.yml , where the output is written to. |
For example to unignore the .well-known/
folder used in LetsEncrypt, add this to your _cobalt.yml
.
ignore: - "!.well-known" - "!.well-known/**/*"
Site options
These are all under site:
in the yaml:
Setting | Format | Description |
---|---|---|
title | String | The title for the site |
description | String | A description for the site |
base_url | String | The root for the site. This is used in making paths absolute for RSS as well as in Liquid ({{ site.base_url }}/docs ). |
data | Object | Values made available via the {{ site.data }} variable. |
In addition to change the defaults through cli options cobalt allows to specify a config file (_cobalt.yml per default) where you can write these configurations in.
Pages and Posts
Setting | Format | Description |
---|---|---|
default | Frontmatter | Site-wide defaults for page frontmatters. |
syntax_highlight | Site-wide syntax highlighting settings | |
- theme | String | Site-wide syntax highlighting theme |
assets | Asset configuration | |
- sass | Sass' CSS generation settings | |
- - style | Nested , Expanded , Compact , Compressed | Site-wide format style for sass-generated CSS |
These are under pages:
in the yaml:
Setting | Format | Description |
---|---|---|
default | Frontmatter | Defaults for page frontmatters. |
These are under posts:
in the yaml:
Setting | Format | Description |
---|---|---|
title | String | Title for the posts collection. Falls back to site.title if not present. |
description | String | Description for the posts collection. Falls back to site.description if not present. |
dir | String | Directory, relative to source , where posts lives. |
drafts_dir | Boolean | Directory, relative to source , where draft posts can live. |
order | Asc , Desc | Sort order for {{posts}} variable. |
rss | String | Path for a posts RSS file. |
jsonfeed | String | Path for a posts jsonfeed file. |
default | Frontmatter | Defaults for post frontmatters. |