What's on this page
Pages
pages.dir
Directory source of pages (pages by default).
pages:
dir: pagespages.ext
Extensions of pages files.
pages:
ext: [md, markdown, mdown, mkdn, mkd, text, txt]pages.exclude
Directories, paths and files name to exclude (accepts globs, strings and regexes).
pages:
exclude: ['vendor', 'node_modules', '*.scss', '/\.bck$/']pages.prefix.separator
List of characters used as separator between a filename prefix (date or weight) and the slug.
pages:
prefix:
separator: ['-', '_']pages.sortby
Default collections sort method.
pages:
sortby: date # `date`, `updated`, `title` or `weight`
# or
sortby:
variable: date # `date`, `updated`, `title` or `weight`
desc_title: false # sort by title in descending order
reverse: false # reverse the sort orderpages.pagination
Pagination is available for list pages (type is homepage, section or term).
pages:
pagination:
max: 5 # maximum number of entries per page
path: page # path to the paginated pageDisable pagination
Pagination can be disabled:
pages:
pagination: falsepages.paths
Apply a custom path for all pages of a Section.
pages:
paths:
- section: <section’s ID>
path: <path of pages>Path placeholders
:year:month:day:section:slug
Example:
pages:
paths:
- section: Blog
path: :section/:year/:month/:day/:slug # e.g.: /blog/2020/12/01/my-post/
# localized
languages:
- code: fr
name: Français
locale: fr_FR
config:
pages:
paths:
- section: Blog
path: blogue/:year/:month/:day/:slug # e.g.: /blogue/2020/12/01/mon-billet/pages.frontmatter
Page front matter format (yaml by default, also accepts ini, toml and json).
pages:
frontmatter: yamlpages.body
Page body options.
pages.body.toc
Headers used to build the table of contents ([h2, h3] by default).
pages:
body:
toc: [h2, h3]pages.body.highlight
Enables code syntax highlighting (true by default).
pages:
body:
highlight: false # set to false to disable syntax highlightingpages.body.images
Images handling options.
pages:
body:
images:
formats: [] # adds alternative image formats as `source` (e.g. `[avif, webp]`, empty array by default)
resize: 0 # resizes all images to <width> (in pixels, `0` to disable)
responsive: false # adds responsive image variants to the `srcset` attribute (`false` by default)
lazy: true # adds `loading="lazy"` attribute (`true` by default)
decoding: true # adds `decoding="async"` attribute (`true` by default)
caption: false # puts the image in a <figure> element and adds a <figcaption> containing the title (`false` by default)
placeholder: '' # fills the <img> background before loading ('color' or 'lqip', empty by default)
class: '' # sets a default class on each image (empty by default)
dark_suffix: '' # suffix of the dark variant image (e.g. `.dark`), disabled by default
mobile_suffix: '' # suffix of the mobile variant image (e.g. `.mobile`), disabled by default
mobile_media_query: '(max-width: 767px)' # media query of the mobile variant `<source>`
remote: # remote image handling (set to `false` to disable)
fallback: # path to the fallback image, stored in assets dir (empty by default)pages.body.links
Links handling options.
pages:
body:
links:
embed:
enabled: false # turns links in embedded content if possible (`false` by default)
video: [mp4, webm] # video files extensions
audio: [mp3] # audio files extensions
external:
blank: false # if true open external link in new tab
noopener: true # if true add "noopener" to `rel` attribute
noreferrer: true # if true add "noreferrer" to `rel` attribute
nofollow: false # if true add "nofollow" to `rel` attributepages.body.excerpt
Excerpt handling options.
pages:
body:
excerpt:
separator: excerpt|break # string to use as separator (`excerpt|break` by default)
capture: before # part to capture, `before` or `after` the separator (`before` by default)pages.virtual
Virtual pages is the best way to create pages without content (front matter only).
It consists of a list of pages with a path and some front matter variables.
Example:
pages:
virtual:
- path: code
redirect: https://github.com/ArnaudLignypages.default
Default pages are pages created automatically by Cecil (from built-in templates):
pages:
default:
index:
path: ''
title: Home
published: true
404:
path: 404
title: Page not found
layout: 404
uglyurl: true
published: true
excluded: true
robots:
path: robots
title: Robots.txt
layout: robots
output: txt
published: true
excluded: true
multilingual: false
sitemap:
path: sitemap
title: XML sitemap
layout: sitemap
output: xml
changefreq: monthly
priority: 0.5
published: true
excluded: true
multilingual: false
xsl/atom:
path: xsl/atom
layout: feed
output: xsl
uglyurl: true
published: true
excluded: true
xsl/rss:
path: xsl/rss
layout: feed
output: xsl
uglyurl: true
published: false
excluded: trueEach one can be:
- disabled:
published: false - excluded from list pages:
excluded: true - excluded from localization:
multilingual: false
pages.generators
Generators are used by Cecil to create additional pages (e.g.: sitemap, feed, pagination, etc.) from existing pages, or from other sources like the configuration file or external sources.
Below the list of Generators provided by Cecil, in a defined order:
pages:
generators:
10: 'Cecil\Generator\DefaultPages'
20: 'Cecil\Generator\VirtualPages'
30: 'Cecil\Generator\ExternalBody'
40: 'Cecil\Generator\Section'
50: 'Cecil\Generator\Taxonomy'
60: 'Cecil\Generator\Homepage'
70: 'Cecil\Generator\Pagination'
80: 'Cecil\Generator\Alias'
90: 'Cecil\Generator\Redirect'pages.subsets
Subsets are used to render a part of the pages collection, based on a specific path, language or output format, with the command:
cecil build --render-subset=<name>pages:
subsets:
<name>:
path: <path> # glob or string path (e.g.: `blog/*`, `blog`)
language: <language> # language code (e.g.: `en`, `fr`)
output: <output> # output format (e.g.: `html`, `atom`)Example:
pages:
subsets:
blog_en:
path: blog
language: en
output: html
search_index:
path: '*'
output: json