{ "version": "https://jsonfeed.org/version/1.1", "title": "Cecil - Configuration", "home_page_url": "https://cecil.app/documentation/configuration/", "feed_url": "https://cecil.app/documentation/configuration/feed.json", "description": "Configure your website with the cecil.yml file.", "icon": "https://cecil.app/favicon.7ff4b89eec6dad139a7d2d6561543285.png", "favicon": "https://cecil.app/thumbnails/64x/favicon.7ff4b89eec6dad139a7d2d6561543285.png", "language": "en", "items": [ { "id": "https://cecil.app/documentation/configuration/site/", "url": "https://cecil.app/documentation/configuration/site/", "title": "Site options", "summary": "title, baseurl, menus, taxonomies, theme, date, metatags, debug, etc.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Site options\ntitle\nMain title of the site.\ntitle: \"<site title>\"\nbaseline\nShort description (~ 20 characters).\nbaseline: \"<baseline>\"\nbaseurl\nThe base URL.\nbaseurl: <url>\nExample:\nbaseurl: http:\/\/localhost:8000\/\nbaseurl should end with a trailing slash (\/).\ncanonicalurl\nIf set to true the url() function will return the absolute URL (false by default).\ncanonicalurl: <true|false> # false by default\ndescription\nSite description (~ 250 characters).\ndescription: \"<description>\"\nmenus\nMenus are used to create navigation links in templates.\nA menu is made up of a unique ID and entry properties (name, URL, weight).\nmenus:\n <name>:\n - id: <unique-id> # unique identifier (required)\n name: \"<name>\" # name displayed in templates\n url: <url> # relative or absolute URL\n weight: <integer> # integer value used to sort entries (lighter first)\nExample:\nmenus:\n main:\n - id: about\n name: \"About\"\n url: \/about\/\n weight: 1\n footer:\n - id: author\n name: The author\n url: https:\/\/arnaudligny.fr\n weight: 99\nA main menu is automatically created with the home page entry and all sections entries (See content management)\nA page can be added to a menu by setting the menu variable in its front matter.\nOverride an entry\nA page menu entry can be overridden: use the page ID as id.\nExample:\nmenus:\n main:\n - id: index\n name: \"My amazing homepage!\"\n weight: 1\nDisable an entry\nA menu entry can be disabled with enabled: false.\nExample:\nmenus:\n main:\n - id: about\n enabled: false\ntaxonomies\nList of vocabularies, paired by plural and singular value.\ntaxonomies:\n <plural>: <singular>\nExample:\ntaxonomies:\n categories: category\n tags: tag\nThen you can use those vocabularies in your content’s front matter.\nSince version 8.37.0, default vocabularies category and tag have been removed. You must define them in the configuration file if you want to use them.\nA vocabulary can be disabled with the special value disabled. Example: tags: disabled.\ntheme\nThe theme to use, or a list of themes.\ntheme: <theme> # theme name\n# or\ntheme:\n - <theme1> # theme name\n - <theme2>\nThe first theme overrides the others, and so on.\nExamples:\ntheme: hyde\ntheme:\n - serviceworker\n - hyde\nSee themes on GitHub or on website themes section.\ndate\nDate format and timezone.\ndate:\n format: <format> # date format (optional, `F j, Y` by default)\n timezone: <timezone> # date timezone (optional, local time zone by default)\n\nformat: PHP date format specifier\ntimezone: see timezones\n\nExample:\ndate:\n format: 'j F, Y'\n timezone: 'Europe\/Paris'\nmetatags\nmetatags are SEO and social helpers that can be automatically injected in the <head>, with the template partials\/metatags.html.twig.\nThis template adds the following meta tags:\n\nPage title + Site title, or Site title + Site baseline\nPage\/Site description\nPage\/Site keywords\nPage\/Site author\nSearch engine crawler directives (robots)\nFavicon links\nNavigation links (first, previous, next, last)\nCanonical URL\nAlternate links (i.e.: RSS feed, others languages)\nrel=me links\nOpen Graph\nFacebook profile ID\nTwitter\/X Card\nFediverse tag\nDublin Core\nStructured data (JSON-LD)\n\nmetatags options\nCecil uses page front matter to feed meta tags, and falls back to site options when needed.\ntitle: \"Page\/Site title\" # used by title meta\ndescription: \"Page\/Site description\" # used by description meta\ntags: [tag1, tag2] # used by keywords meta\nkeywords: [keyword1, keyword2] # obsolete\nauthor: # used by author meta\n name: <name> # author name\n url: <url> # author URL\n email: <email> # author email\nimage: image.jpg # used by Open Graph and social networks cards\ncanonical: # used to override the generated canonical URL\n url: <URL> # absolute URL\n title: \"<URL title>\" # optional canonical title\nsocial: # used by social networks meta\n twitter: # used by Twitter\/X Card\n url: <URL> # used for `rel=me` link\n site: username # site username\n creator: username # page author username\n mastodon: # used by Mastodon meta\n url: <URL> # used for `rel=me` link\n creator: handle # page author account\n facebook: # used by Facebook meta\n url: <URL> # used for `rel=me` link\n id: 123456789 # Facebook profile ID\n username: username # page author username\nIf needed, title and image can be overridden:\n{{ include('partials\/metatags.html.twig', {title: 'Custom title', image: og_image}) }}\nmetatags configuration\nmetatags:\n title: # title options\n divider: \" &middot; \" # string between page title and site title\n only: false # displays page title only (`false` by default)\n pagination: # pagination options\n shownumber: true # displays page number in title (`true` by default)\n label: \"Page %s\" # how to display page number (`Page %s` by default)\n robots: \"index,follow\" # web crawlers directives (`index,follow` by default)\n favicon: # favicon options\n enabled: true # includes favicon (`true` by default)\n image: favicon.png # path to favicon image\n sizes: # sizes by device\n - \"icon\": [32, 57, 76, 96, 128, 192, 228] # web browsers\n - \"shortcut icon\": [196] # Android\n - \"apple-touch-icon\": [120, 152, 180] # iOS\n navigation: true # includes previous and next links (`true` by default)\n image: true # includes image (`true` by default)\n og: true # includes Open Graph meta tags (`true` by default)\n articles: \"blog\" # articles' section (`blog` by default)\n twitter: true # includes Twitter\/X Card meta tags (`true` by default)\n mastodon: true # includes Mastodon meta tags (`true` by default)\n dc: false # includes Dublin Core meta tags (`false` by default)\n data: false # includes JSON-LD structured data (`false` by default)\ndebug\nEnables the debug mode, used to display debug information like very verbose logs, Twig dump, Twig profiler, SCSS sourcemap, etc.\ndebug: true\nThere are two other ways to enable debug mode:\n\nRun a command with the -vvv option\nSet the CECIL_DEBUG environment variable to true\n\n", "content_html": "

Site options

\n

title

\n

Main title of the site.

\n
title: \"<site title>\"
\n

baseline

\n

Short description (~ 20 characters).

\n
baseline: \"<baseline>\"
\n

baseurl

\n

The base URL.

\n
baseurl: <url>
\n

Example:

\n
baseurl: http://localhost:8000/
\n\n

canonicalurl

\n

If set to true the url() function will return the absolute URL (false by default).

\n
canonicalurl: <true|false> # false by default
\n

description

\n

Site description (~ 250 characters).

\n
description: \"<description>\"
\n

menus

\n

Menus are used to create navigation links in templates.

\n

A menu is made up of a unique ID and entry properties (name, URL, weight).

\n
menus:\n  <name>:\n    - id: <unique-id>   # unique identifier (required)\n      name: \"<name>\"    # name displayed in templates\n      url: <url>        # relative or absolute URL\n      weight: <integer> # integer value used to sort entries (lighter first)
\n

Example:

\n
menus:\n  main:\n    - id: about\n      name: \"About\"\n      url: /about/\n      weight: 1\n  footer:\n    - id: author\n      name: The author\n      url: https://arnaudligny.fr\n      weight: 99
\n\n\n

Override an entry

\n

A page menu entry can be overridden: use the page ID as id.

\n

Example:

\n
menus:\n  main:\n    - id: index\n      name: \"My amazing homepage!\"\n      weight: 1
\n

Disable an entry

\n

A menu entry can be disabled with enabled: false.

\n

Example:

\n
menus:\n  main:\n    - id: about\n      enabled: false
\n

taxonomies

\n

List of vocabularies, paired by plural and singular value.

\n
taxonomies:\n  <plural>: <singular>
\n

Example:

\n
taxonomies:\n  categories: category\n  tags: tag
\n

Then you can use those vocabularies in your content’s front matter.

\n\n\n

theme

\n

The theme to use, or a list of themes.

\n
theme: <theme> # theme name\n# or\ntheme:\n  - <theme1> # theme name\n  - <theme2>
\n\n

Examples:

\n
theme: hyde
\n
theme:\n  - serviceworker\n  - hyde
\n\n

date

\n

Date format and timezone.

\n
date:\n  format: <format>     # date format (optional, `F j, Y` by default)\n  timezone: <timezone> # date timezone (optional, local time zone by default)
\n\n

Example:

\n
date:\n  format: 'j F, Y'\n  timezone: 'Europe/Paris'
\n

metatags

\n

metatags are SEO and social helpers that can be automatically injected in the <head>, with the template partials/metatags.html.twig.

\n

This template adds the following meta tags:

\n\n

metatags options

\n

Cecil uses page front matter to feed meta tags, and falls back to site options when needed.

\n
title: \"Page/Site title\"              # used by title meta\ndescription: \"Page/Site description\"  # used by description meta\ntags: [tag1, tag2]                    # used by keywords meta\nkeywords: [keyword1, keyword2]        # obsolete\nauthor:                               # used by author meta\n  name: <name>                          # author name\n  url: <url>                            # author URL\n  email: <email>                        # author email\nimage: image.jpg                      # used by Open Graph and social networks cards\ncanonical:                            # used to override the generated canonical URL\n  url: <URL>                            # absolute URL\n  title: \"<URL title>\"                  # optional canonical title\nsocial:                               # used by social networks meta\n  twitter:                              # used by Twitter/X Card\n    url: <URL>                            # used for `rel=me` link\n    site: username                        # site username\n    creator: username                     # page author username\n  mastodon:                             # used by Mastodon meta\n    url: <URL>                            # used for `rel=me` link\n    creator: handle                       # page author account\n  facebook:                             # used by Facebook meta\n    url: <URL>                            # used for `rel=me` link\n    id: 123456789                         # Facebook profile ID\n    username: username                    # page author username
\n\n

metatags configuration

\n
metatags:\n  title:                   # title options\n    divider: \" &middot; \"    # string between page title and site title\n    only: false              # displays page title only (`false` by default)\n    pagination:              # pagination options\n      shownumber: true         # displays page number in title (`true` by default)\n      label: \"Page %s\"         # how to display page number (`Page %s` by default)\n  robots: \"index,follow\"   # web crawlers directives (`index,follow` by default)\n  favicon:                 # favicon options\n    enabled: true            # includes favicon (`true` by default)\n    image: favicon.png       # path to favicon image\n    sizes:                   # sizes by device\n      - \"icon\": [32, 57, 76, 96, 128, 192, 228]  # web browsers\n      - \"shortcut icon\": [196]                   # Android\n      - \"apple-touch-icon\": [120, 152, 180]      # iOS\n  navigation: true         # includes previous and next links (`true` by default)\n  image: true              # includes image (`true` by default)\n  og: true                 # includes Open Graph meta tags (`true` by default)\n  articles: \"blog\"         # articles' section (`blog` by default)\n  twitter: true            # includes Twitter/X Card meta tags (`true` by default)\n  mastodon: true           # includes Mastodon meta tags (`true` by default)\n  dc: false                # includes Dublin Core meta tags (`false` by default)\n  data: false              # includes JSON-LD structured data (`false` by default)
\n

debug

\n

Enables the debug mode, used to display debug information like very verbose logs, Twig dump, Twig profiler, SCSS sourcemap, etc.

\n
debug: true
\n

There are two other ways to enable debug mode:

\n
    \n
  1. Run a command with the -vvv option
    2. \n
  2. Set the CECIL_DEBUG environment variable to true
    3. \n
\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/languages/", "url": "https://cecil.app/documentation/configuration/languages/", "title": "Languages", "summary": "Main language and additional languages of a multilingual website.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Languages\nlanguage\nThe main language, defined by its code.\nlanguage: <code> # unique code (`en` by default)\nBy default only others languages pages path are prefixed with its language code, but you can prefix the path of the main language pages with the following option:\n#language: <code>\nlanguage:\n code: <code>\n prefix: true\nWhen prefix is set to true, an alias is automatically created for the home page that redirect from\/ to \/<code>\/.\nlanguages\nOptions of available languages, used for pages and templates localization.\nlanguages:\n - code: <code> # unique code (e.g.: `en`, `fr`, 'en-US', `fr-CA`)\n name: <name> # human readable name (e.g.: `Français`)\n locale: <locale> # locale code (`language_COUNTRY`, e.g.: `en_US`, `fr_FR`, `fr_CA`)\n enabled: <true|false> # enabled or not (`true` by default)\nExample:\nlanguage: en\nlanguages:\n - code: en\n name: English\n locale: en_US\n - code: fr\n name: Français\n locale: fr_FR\nA locale code list is available if needed.\nLocalize\nTo localize configuration options you must store them under the config key of the language.\nExample:\ntitle: \"Cecil in english\"\nlanguages:\n - code: en\n name: English\n locale: en_US\n - code: fr\n name: Français\n locale: fr_FR\n config:\n title: \"Cecil en français\"\nIn templates you can access to an option with {{ site.<option> }}, for example {{ site.title }}.\nIf an option is not available in the current language (e.g.: fr) it fallback to the global one (e.g.: en).", "content_html": "

Languages

\n

language

\n

The main language, defined by its code.

\n
language: <code> # unique code (`en` by default)
\n

By default only others languages pages path are prefixed with its language code, but you can prefix the path of the main language pages with the following option:

\n
#language: <code>\nlanguage:\n  code: <code>\n  prefix: true
\n\n

languages

\n

Options of available languages, used for pages and templates localization.

\n
languages:\n  - code: <code>          # unique code (e.g.: `en`, `fr`, 'en-US', `fr-CA`)\n    name: <name>          # human readable name (e.g.: `Français`)\n    locale: <locale>      # locale code (`language_COUNTRY`, e.g.: `en_US`, `fr_FR`, `fr_CA`)\n    enabled: <true|false> # enabled or not (`true` by default)
\n

Example:

\n
language: en\nlanguages:\n  - code: en\n    name: English\n    locale: en_US\n  - code: fr\n    name: Français\n    locale: fr_FR
\n\n

Localize

\n

To localize configuration options you must store them under the config key of the language.

\n

Example:

\n
title: \"Cecil in english\"\nlanguages:\n  - code: en\n    name: English\n    locale: en_US\n  - code: fr\n    name: Français\n    locale: fr_FR\n    config:\n      title: \"Cecil en français\"
\n", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/pages/", "url": "https://cecil.app/documentation/configuration/pages/", "title": "Pages", "summary": "Pages directory, sorting, pagination, paths, body, virtual pages, generators, etc.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Pages\npages.dir\nDirectory source of pages (pages by default).\npages:\n dir: pages\npages.ext\nExtensions of pages files.\npages:\n ext: [md, markdown, mdown, mkdn, mkd, text, txt]\npages.exclude\nDirectories, paths and files name to exclude (accepts globs, strings and regexes).\npages:\n exclude: ['vendor', 'node_modules', '*.scss', '\/\\.bck$\/']\npages.prefix.separator\nList of characters used as separator between a filename prefix (date or weight) and the slug.\npages:\n prefix:\n separator: ['-', '_']\npages.sortby\nDefault collections sort method.\npages:\n sortby: date # `date`, `updated`, `title` or `weight`\n # or\n sortby:\n variable: date # `date`, `updated`, `title` or `weight`\n desc_title: false # sort by title in descending order\n reverse: false # reverse the sort order\npages.pagination\nPagination is available for list pages (type is homepage, section or term).\npages:\n pagination:\n max: 5 # maximum number of entries per page\n path: page # path to the paginated page\nDisable pagination\nPagination can be disabled:\npages:\n pagination: false\npages.paths\nApply a custom path for all pages of a Section.\npages:\n paths:\n - section: <section’s ID>\n path: <path of pages>\nPath placeholders\n\n:year\n:month\n:day\n:section\n:slug\n\nExample:\npages:\n paths:\n - section: Blog\n path: :section\/:year\/:month\/:day\/:slug # e.g.: \/blog\/2020\/12\/01\/my-post\/\n# localized\nlanguages:\n - code: fr\n name: Français\n locale: fr_FR\n config:\n pages:\n paths:\n - section: Blog\n path: blogue\/:year\/:month\/:day\/:slug # e.g.: \/blogue\/2020\/12\/01\/mon-billet\/\npages.frontmatter\nPage front matter format (yaml by default, also accepts ini, toml and json).\npages:\n frontmatter: yaml\npages.body\nPage body options.\nTo know how those options impacts your content see Content > Markdown documentation.\npages.body.toc\nHeaders used to build the table of contents ([h2, h3] by default).\npages:\n body:\n toc: [h2, h3]\npages.body.highlight\nEnables code syntax highlighting (true by default).\npages:\n body:\n highlight: false # set to false to disable syntax highlighting\npages.body.images\nImages handling options.\npages:\n body:\n images:\n formats: [] # adds alternative image formats as `source` (e.g. `[avif, webp]`, empty array by default)\n resize: 0 # resizes all images to <width> (in pixels, `0` to disable)\n responsive: false # adds responsive image variants to the `srcset` attribute (`false` by default)\n lazy: true # adds `loading=\"lazy\"` attribute (`true` by default)\n decoding: true # adds `decoding=\"async\"` attribute (`true` by default)\n caption: false # puts the image in a <figure> element and adds a <figcaption> containing the title (`false` by default)\n placeholder: '' # fills the <img> background before loading ('color' or 'lqip', empty by default)\n class: '' # sets a default class on each image (empty by default)\n dark_suffix: '' # suffix of the dark variant image (e.g. `.dark`), disabled by default\n mobile_suffix: '' # suffix of the mobile variant image (e.g. `.mobile`), disabled by default\n mobile_media_query: '(max-width: 767px)' # media query of the mobile variant `<source>`\n remote: # remote image handling (set to `false` to disable)\n fallback: # path to the fallback image, stored in assets dir (empty by default)\nSince version 8.41.0, the pages.body.images.resize option is used to resize images to a specific width, no more to enable the resize feature (enabled systematically).\nGlobal options, like responsives images widths and sizes, are configurable in the assets.images section.\nRemote images are downloaded and converted into Assets to be manipulated. You can disable this behavior by setting the option pages.body.images.remote.enabled to false.\nWhen dark_suffix is set (e.g. dark_suffix: .dark), Cecil automatically looks for a dark variant of each image (e.g. photo.dark.jpg alongside photo.jpg). If found, the image is wrapped in a <picture> element with a <source media=\"(prefers-color-scheme: dark)\"> for automatic light\/dark theme switching. Works in combination with formats and responsive.\nIn the same way, when mobile_suffix is set (e.g. mobile_suffix: .mobile), Cecil looks for a mobile variant of each image (e.g. photo.mobile.jpg alongside photo.jpg) and adds a <source> element with the mobile_media_query media query ((max-width: 767px) by default). If dark_suffix is also set, the dark variant of the mobile image (e.g. photo.mobile.dark.jpg) is used on mobile with dark color scheme. Mobile sources are placed before dark sources, so that a mobile variant takes precedence.\npages.body.links\nLinks handling options.\npages:\n body:\n links:\n embed:\n enabled: false # turns links in embedded content if possible (`false` by default)\n video: [mp4, webm] # video files extensions\n audio: [mp3] # audio files extensions\n external:\n blank: false # if true open external link in new tab\n noopener: true # if true add \"noopener\" to `rel` attribute\n noreferrer: true # if true add \"noreferrer\" to `rel` attribute\n nofollow: false # if true add \"nofollow\" to `rel` attribute\npages.body.excerpt\nExcerpt handling options.\npages:\n body:\n excerpt:\n separator: excerpt|break # string to use as separator (`excerpt|break` by default)\n capture: before # part to capture, `before` or `after` the separator (`before` by default)\npages.virtual\nVirtual pages is the best way to create pages without content (front matter only).\nIt consists of a list of pages with a path and some front matter variables.\nExample:\npages:\n virtual:\n - path: code\n redirect: https:\/\/github.com\/ArnaudLigny\npages.default\nDefault pages are pages created automatically by Cecil (from built-in templates):\npages:\n default:\n index:\n path: ''\n title: Home\n published: true\n 404:\n path: 404\n title: Page not found\n layout: 404\n uglyurl: true\n published: true\n excluded: true\n robots:\n path: robots\n title: Robots.txt\n layout: robots\n output: txt\n published: true\n excluded: true\n multilingual: false\n sitemap:\n path: sitemap\n title: XML sitemap\n layout: sitemap\n output: xml\n changefreq: monthly\n priority: 0.5\n published: true\n excluded: true\n multilingual: false\n xsl\/atom:\n path: xsl\/atom\n layout: feed\n output: xsl\n uglyurl: true\n published: true\n excluded: true\n xsl\/rss:\n path: xsl\/rss\n layout: feed\n output: xsl\n uglyurl: true\n published: false\n excluded: true\nThe structure is almost identical of pages.virtual, except the named key.\nEach one can be:\n\ndisabled: published: false\nexcluded from list pages: excluded: true\nexcluded from localization: multilingual: false\n\nSince version 8.68.0 you can override the default robots.txt page by creating a page with the same path:\npages\/robots.md\n---\nlayout: robots\noutput: txt\n---\nUser-agent: AI-bot\nDisallow: \/\npages.generators\nGenerators 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.\nBelow the list of Generators provided by Cecil, in a defined order:\npages:\n generators:\n 10: 'Cecil\\Generator\\DefaultPages'\n 20: 'Cecil\\Generator\\VirtualPages'\n 30: 'Cecil\\Generator\\ExternalBody'\n 40: 'Cecil\\Generator\\Section'\n 50: 'Cecil\\Generator\\Taxonomy'\n 60: 'Cecil\\Generator\\Homepage'\n 70: 'Cecil\\Generator\\Pagination'\n 80: 'Cecil\\Generator\\Alias'\n 90: 'Cecil\\Generator\\Redirect'\nYou can extend Cecil with Pages generator.\npages.subsets\nSubsets are used to render a part of the pages collection, based on a specific path, language or output format, with the command:\ncecil build --render-subset=<name>\npages:\n subsets:\n <name>:\n path: <path> # glob or string path (e.g.: `blog\/*`, `blog`)\n language: <language> # language code (e.g.: `en`, `fr`)\n output: <output> # output format (e.g.: `html`, `atom`)\nExample:\npages:\n subsets:\n blog_en:\n path: blog\n language: en\n output: html\n search_index:\n path: '*'\n output: json\n", "content_html": "

Pages

\n

pages.dir

\n

Directory source of pages (pages by default).

\n
pages:\n  dir: pages
\n

pages.ext

\n

Extensions of pages files.

\n
pages:\n  ext: [md, markdown, mdown, mkdn, mkd, text, txt]
\n

pages.exclude

\n

Directories, paths and files name to exclude (accepts globs, strings and regexes).

\n
pages:\n  exclude: ['vendor', 'node_modules', '*.scss', '/\\.bck$/']
\n

pages.prefix.separator

\n

List of characters used as separator between a filename prefix (date or weight) and the slug.

\n
pages:\n  prefix:\n    separator: ['-', '_']
\n

pages.sortby

\n

Default collections sort method.

\n
pages:\n  sortby: date # `date`, `updated`, `title` or `weight`\n  # or\n  sortby:\n    variable: date    # `date`, `updated`, `title` or `weight`\n    desc_title: false # sort by title in descending order\n    reverse: false    # reverse the sort order
\n

pages.pagination

\n

Pagination is available for list pages (type is homepage, section or term).

\n
pages:\n  pagination:\n    max: 5     # maximum number of entries per page\n    path: page # path to the paginated page
\n

Disable pagination

\n

Pagination can be disabled:

\n
pages:\n  pagination: false
\n

pages.paths

\n

Apply a custom path for all pages of a Section.

\n
pages:\n  paths:\n    - section: <section’s ID>\n      path: <path of pages>
\n

Path placeholders

\n\n

Example:

\n
pages:\n  paths:\n    - section: Blog\n      path: :section/:year/:month/:day/:slug # e.g.: /blog/2020/12/01/my-post/\n# localized\nlanguages:\n  - code: fr\n    name: Français\n    locale: fr_FR\n    config:\n      pages:\n        paths:\n          - section: Blog\n            path: blogue/:year/:month/:day/:slug # e.g.: /blogue/2020/12/01/mon-billet/
\n

pages.frontmatter

\n

Page front matter format (yaml by default, also accepts ini, toml and json).

\n
pages:\n  frontmatter: yaml
\n

pages.body

\n

Page body options.

\n\n

pages.body.toc

\n

Headers used to build the table of contents ([h2, h3] by default).

\n
pages:\n  body:\n    toc: [h2, h3]
\n

pages.body.highlight

\n

Enables code syntax highlighting (true by default).

\n
pages:\n  body:\n    highlight: false # set to false to disable syntax highlighting
\n

pages.body.images

\n

Images handling options.

\n
pages:\n  body:\n    images:\n      formats: []       # adds alternative image formats as `source` (e.g. `[avif, webp]`, empty array by default)\n      resize: 0         # resizes all images to <width> (in pixels, `0` to disable)\n      responsive: false # adds responsive image variants to the `srcset` attribute (`false` by default)\n      lazy: true        # adds `loading=\"lazy\"` attribute (`true` by default)\n      decoding: true    # adds `decoding=\"async\"` attribute (`true` by default)\n      caption: false    # puts the image in a <figure> element and adds a <figcaption> containing the title (`false` by default)\n      placeholder: ''   # fills the <img> background before loading ('color' or 'lqip', empty by default)\n      class: ''         # sets a default class on each image (empty by default)\n      dark_suffix: ''   # suffix of the dark variant image (e.g. `.dark`), disabled by default\n      mobile_suffix: '' # suffix of the mobile variant image (e.g. `.mobile`), disabled by default\n      mobile_media_query: '(max-width: 767px)' # media query of the mobile variant `<source>`\n      remote:           # remote image handling (set to `false` to disable)\n        fallback:         # path to the fallback image, stored in assets dir (empty by default)
\n\n\n\n\n

pages.body.links

\n

Links handling options.

\n
pages:\n  body:\n    links:\n      embed:\n        enabled: false     # turns links in embedded content if possible (`false` by default)\n        video: [mp4, webm] # video files extensions\n        audio: [mp3]       # audio files extensions\n      external:\n        blank: false     # if true open external link in new tab\n        noopener: true   # if true add \"noopener\" to `rel` attribute\n        noreferrer: true # if true add \"noreferrer\" to `rel` attribute\n        nofollow: false  # if true add \"nofollow\" to `rel` attribute
\n

pages.body.excerpt

\n

Excerpt handling options.

\n
pages:\n  body:\n    excerpt:\n      separator: excerpt|break # string to use as separator (`excerpt|break` by default)\n      capture: before          # part to capture, `before` or `after` the separator (`before` by default)
\n

pages.virtual

\n

Virtual pages is the best way to create pages without content (front matter only).

\n

It consists of a list of pages with a path and some front matter variables.

\n

Example:

\n
pages:\n  virtual:\n    - path: code\n      redirect: https://github.com/ArnaudLigny
\n

pages.default

\n

Default pages are pages created automatically by Cecil (from built-in templates):

\n
pages:\n  default:\n    index:\n      path: ''\n      title: Home\n      published: true\n    404:\n      path: 404\n      title: Page not found\n      layout: 404\n      uglyurl: true\n      published: true\n      excluded: true\n    robots:\n      path: robots\n      title: Robots.txt\n      layout: robots\n      output: txt\n      published: true\n      excluded: true\n      multilingual: false\n    sitemap:\n      path: sitemap\n      title: XML sitemap\n      layout: sitemap\n      output: xml\n      changefreq: monthly\n      priority: 0.5\n      published: true\n      excluded: true\n      multilingual: false\n    xsl/atom:\n      path: xsl/atom\n      layout: feed\n      output: xsl\n      uglyurl: true\n      published: true\n      excluded: true\n    xsl/rss:\n      path: xsl/rss\n      layout: feed\n      output: xsl\n      uglyurl: true\n      published: false\n      excluded: true
\n\n

Each one can be:

\n
    \n
  1. disabled: published: false
    2. \n
  2. excluded from list pages: excluded: true
    3. \n
  3. excluded from localization: multilingual: false
    4. \n
\n\n

pages.generators

\n

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.

\n

Below the list of Generators provided by Cecil, in a defined order:

\n
pages:\n  generators:\n    10: 'Cecil\\Generator\\DefaultPages'\n    20: 'Cecil\\Generator\\VirtualPages'\n    30: 'Cecil\\Generator\\ExternalBody'\n    40: 'Cecil\\Generator\\Section'\n    50: 'Cecil\\Generator\\Taxonomy'\n    60: 'Cecil\\Generator\\Homepage'\n    70: 'Cecil\\Generator\\Pagination'\n    80: 'Cecil\\Generator\\Alias'\n    90: 'Cecil\\Generator\\Redirect'
\n\n

pages.subsets

\n

Subsets are used to render a part of the pages collection, based on a specific path, language or output format, with the command:

\n
cecil build --render-subset=<name>
\n
pages:\n  subsets:\n    <name>:\n      path: <path> # glob or string path (e.g.: `blog/*`, `blog`)\n      language: <language> # language code (e.g.: `en`, `fr`)\n      output: <output> # output format (e.g.: `html`, `atom`)
\n

Example:

\n
pages:\n  subsets:\n    blog_en:\n      path: blog\n      language: en\n      output: html\n    search_index:\n      path: '*'\n      output: json
\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/data-static/", "url": "https://cecil.app/documentation/configuration/data-static/", "title": "Data and static files", "summary": "Data files and static files options.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Data and static files\nData\nWhere data files are stored and what extensions are handled.\nSupported formats: YAML, JSON, XML and CSV.\ndata.dir\nData source directory (data by default).\ndata:\n dir: data\ndata.ext\nArray of files extensions.\ndata:\n ext: [yaml, yml, json, xml, csv]\ndata.load\nEnables site.data collection (true by default).\ndata:\n load: true\n\nStatic\nManagement of static files are copied (PDF, fonts, etc.).\nYou should put your assets files, used by asset(), in the assets directory to avoid unnecessary files copy.\nstatic.dir\nStatic files source directory (static by default).\nstatic:\n dir: static\nstatic.target\nDirectory where static files are copied (root by default).\nstatic:\n target: ''\nstatic.exclude\nList of excluded files. Accepts globs, strings and regexes.\nstatic:\n exclude: ['sass', 'scss', '*.scss', 'package*.json', 'node_modules']\nIf you use Bootstrap Icons you can exclude the node_modules except node_modules\/bootstrap-icons with a regular expression:\nexclude: ['sass', 'scss', '*.scss', 'package*.json', '#node_modules\/(?!bootstrap-icons)#']\nstatic.load\nEnables site.static collection (false by default).\nstatic:\n load: false\nstatic.mounts\nAllows to copy specific files or directories to a specific destination.\nstatic:\n mounts: []\nstatic example\nstatic:\n dir: docs\n target: docs\n exclude: ['sass', '*.scss', '\/\\.bck$\/']\n load: true\n mounts:\n - source\/path\/file.ext: dest\/path\/file.ext\n - node_modules\/bootstrap-icons\/font\/fonts: fonts", "content_html": "

Data and static files

\n

Data

\n

Where data files are stored and what extensions are handled.

\n

Supported formats: YAML, JSON, XML and CSV.

\n

data.dir

\n

Data source directory (data by default).

\n
data:\n  dir: data
\n

data.ext

\n

Array of files extensions.

\n
data:\n  ext: [yaml, yml, json, xml, csv]
\n

data.load

\n

Enables site.data collection (true by default).

\n
data:\n  load: true
\n
\n

Static

\n

Management of static files are copied (PDF, fonts, etc.).

\n\n

static.dir

\n

Static files source directory (static by default).

\n
static:\n  dir: static
\n

static.target

\n

Directory where static files are copied (root by default).

\n
static:\n  target: ''
\n

static.exclude

\n

List of excluded files. Accepts globs, strings and regexes.

\n
static:\n  exclude: ['sass', 'scss', '*.scss', 'package*.json', 'node_modules']
\n\n

static.load

\n

Enables site.static collection (false by default).

\n
static:\n  load: false
\n

static.mounts

\n

Allows to copy specific files or directories to a specific destination.

\n
static:\n  mounts: []
\n

static example

\n
static:\n  dir: docs\n  target: docs\n  exclude: ['sass', '*.scss', '/\\.bck$/']\n  load: true\n  mounts:\n    - source/path/file.ext: dest/path/file.ext\n    - node_modules/bootstrap-icons/font/fonts: fonts
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/assets/", "url": "https://cecil.app/documentation/configuration/assets/", "title": "Assets", "summary": "Assets directory, compilation, minification, images and CDN.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Assets\nAssets management (images, CSS and JS files).\nassets.dir\nAssets source directory (assets by default).\nassets:\n dir: assets\nassets.target\nDirectory where remote and resized assets files are saved (root by default).\nassets:\n target: ''\nassets.fingerprint\nEnables fingerprinting (cache busting) for assets files (true by default).\nassets:\n fingerprint: true\nassets.compile\nEnables Sass files compilation (true by default). See the documentation of scssphp for options details.\nassets:\n compile:\n style: expanded # compilation style (`expanded` or `compressed`. `expanded` by default)\n import: [sass, scss] # list of imported paths (`[sass, scss, node_modules]` by default)\n sourcemap: false # enables sourcemap in debug mode (`false` by default)\n variables: [] # list of preset variables (empty by default)\nsourcemap is used to debug SCSS compilation (debug mode must be enabled).\nassets.minify\nEnables CSS and JS minification (true by default).\nassets:\n minify: true\nassets.images\nImages management.\nassets:\n images:\n optimize: false # enables images optimization with JpegOptim, Optipng, Pngquant 2, SVGO 1, Gifsicle, cwebp, avifenc (`false` by default)\n quality: 75 # image quality of `optimize` and `resize` (`75` by default)\n responsive:\n widths: [480, 640, 768, 1024, 1366, 1600, 1920] # `srcset` attribute images widths\n sizes:\n default: '100vw' # default `sizes` attribute (`100vw` by default)\nassets.images.cdn\nURL of image assets can be easily replaced by a provided CDN url.\nassets:\n images:\n cdn:\n enabled: false # enables Image CDN (`false` by default)\n canonical: true # `image_url` is canonical (instead of a relative path) (`true` by default)\n remote: true # handles not local images too (`true` by default)\n account: 'xxxx' # provider account\n url: 'https:\/\/provider.tld\/%account%\/%image_url%?w=%width%&q=%quality%&format=%format%'\nurl is a pattern that contains variables:\n\n%account% replaced by the assets.images.cdn.account option\n%image_url% replaced by the image canonical URL or path\n%width% replaced by the image width\n%quality% replaced by the assets.images.quality option\n%format% replaced by the image format\n\nSee CDN providers.\nassets.remote.useragent\nUser agent used to download remote assets.\nassets:\n remote:\n useragent:\n default: <string> # default user agent\n useragent1: <string>\n useragent2: <string>", "content_html": "

Assets

\n

Assets management (images, CSS and JS files).

\n

assets.dir

\n

Assets source directory (assets by default).

\n
assets:\n  dir: assets
\n

assets.target

\n

Directory where remote and resized assets files are saved (root by default).

\n
assets:\n  target: ''
\n

assets.fingerprint

\n

Enables fingerprinting (cache busting) for assets files (true by default).

\n
assets:\n  fingerprint: true
\n

assets.compile

\n

Enables Sass files compilation (true by default). See the documentation of scssphp for options details.

\n
assets:\n  compile:\n    style: expanded      # compilation style (`expanded` or `compressed`. `expanded` by default)\n    import: [sass, scss] # list of imported paths (`[sass, scss, node_modules]` by default)\n    sourcemap: false     # enables sourcemap in debug mode (`false` by default)\n    variables: []        # list of preset variables (empty by default)
\n\n

assets.minify

\n

Enables CSS and JS minification (true by default).

\n
assets:\n  minify: true
\n

assets.images

\n

Images management.

\n
assets:\n  images:\n    optimize: false # enables images optimization with JpegOptim, Optipng, Pngquant 2, SVGO 1, Gifsicle, cwebp, avifenc (`false` by default)\n    quality: 75     # image quality of `optimize` and `resize` (`75` by default)\n    responsive:\n      widths: [480, 640, 768, 1024, 1366, 1600, 1920] # `srcset` attribute images widths\n      sizes:\n        default: '100vw' # default `sizes` attribute (`100vw` by default)
\n

assets.images.cdn

\n

URL of image assets can be easily replaced by a provided CDN url.

\n
assets:\n  images:\n    cdn:\n      enabled: false  # enables Image CDN (`false` by default)\n      canonical: true # `image_url` is canonical (instead of a relative path) (`true` by default)\n      remote: true    # handles not local images too (`true` by default)\n      account: 'xxxx' # provider account\n      url: 'https://provider.tld/%account%/%image_url%?w=%width%&q=%quality%&format=%format%'
\n

url is a pattern that contains variables:

\n\n

See CDN providers.

\n

assets.remote.useragent

\n

User agent used to download remote assets.

\n
assets:\n  remote:\n    useragent:\n      default: <string> # default user agent\n      useragent1: <string>\n      useragent2: <string>
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/layouts/", "url": "https://cecil.app/documentation/configuration/layouts/", "title": "Layouts", "summary": "Templates directory, auto-escaping, images, translations and components.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Layouts\nTemplates options.\nlayouts.dir\nTemplates directory source (layouts by default).\nlayouts:\n dir: layouts\nlayouts.autoescape\nOverrides Twig autoescape option (false by default).\nIf set to null, Cecil uses an extension-based strategy:\n\n*.js.twig -> js\n*.css.twig -> css\n*.html.twig and *.twig -> html\nany other extension -> false\n\nlayouts:\n autoescape: false # disables automatic escaping (default) \n #autoescape: null # use Cecil automatic strategy by template filename extension \n #autoescape: html\n #autoescape: js\nlayouts.images\nImages handling options.\nlayouts:\n images:\n formats: [] # used by `html` function: adds alternatives image formats as `source` (e.g. `[avif, webp]`, empty array by default)\n responsive: false # used by `html` function: adds responsive images ('width' or 'density', `false` by default)\n placeholder: '' # used by `html` function: fills image background before loading (`color` or `lqip`, disabled by default)\n dark_suffix: '' # suffix of the dark variant image (e.g. `.dark`), disabled by default\n mobile_suffix: '' # suffix of the mobile variant image (e.g. `.mobile`), disabled by default\n mobile_media_query: '(max-width: 767px)' # media query of the mobile variant `<source>`\nlayouts.translations\nTranslations handling options.\nlayouts:\n translations:\n dir: translations # translations source directory (`translations` by default)\n formats: # translations supported formats\n yaml:\n loader: Symfony\\Component\\Translation\\Loader\\YamlFileLoader\n ext: [yml, yaml]\n mo:\n loader: Symfony\\Component\\Translation\\Loader\\MoFileLoader\n ext: [mo]\nEach translation format defines:\n\nloader: Symfony translation loader class\next: one or more file extensions associated with this format\n\nlayouts.components\nTemplates Components options.\nlayouts:\n components:\n dir: components # components source directory (`components` by default)\n ext: twig # components files extension (`twig` by default)\nlayouts.sections\nMaps a section to the layouts of another section: the mapped name is used in place of <section> by the lookup rules of the section and of its pages.\nlayouts:\n sections:\n news: blog # the \"news\" section is rendered with `blog\/list.html.twig` and its pages with `blog\/page.html.twig`\nA sub-section already falls back to the layouts of its parent sections: no mapping is needed for that.\n", "content_html": "

Layouts

\n

Templates options.

\n

layouts.dir

\n

Templates directory source (layouts by default).

\n
layouts:\n  dir: layouts
\n

layouts.autoescape

\n

Overrides Twig autoescape option (false by default).

\n

If set to null, Cecil uses an extension-based strategy:

\n\n
layouts:\n  autoescape: false  # disables automatic escaping (default) \n  #autoescape: null  # use Cecil automatic strategy by template filename extension \n  #autoescape: html\n  #autoescape: js
\n

layouts.images

\n

Images handling options.

\n
layouts:\n  images:\n    formats: []       # used by `html` function: adds alternatives image formats as `source` (e.g. `[avif, webp]`, empty array by default)\n    responsive: false # used by `html` function: adds responsive images ('width' or 'density', `false` by default)\n    placeholder: ''   # used by `html` function: fills image background before loading (`color` or `lqip`, disabled by default)\n    dark_suffix: ''   # suffix of the dark variant image (e.g. `.dark`), disabled by default\n    mobile_suffix: '' # suffix of the mobile variant image (e.g. `.mobile`), disabled by default\n    mobile_media_query: '(max-width: 767px)' # media query of the mobile variant `<source>`
\n

layouts.translations

\n

Translations handling options.

\n
layouts:\n  translations:\n    dir: translations # translations source directory (`translations` by default)\n    formats:          # translations supported formats\n      yaml:\n        loader: Symfony\\Component\\Translation\\Loader\\YamlFileLoader\n        ext: [yml, yaml]\n      mo:\n        loader: Symfony\\Component\\Translation\\Loader\\MoFileLoader\n        ext: [mo]
\n

Each translation format defines:

\n\n

layouts.components

\n

Templates Components options.

\n
layouts:\n  components:\n    dir: components # components source directory (`components` by default)\n    ext: twig       # components files extension (`twig` by default)
\n

layouts.sections

\n

Maps a section to the layouts of another section: the mapped name is used in place of <section> by the lookup rules of the section and of its pages.

\n
layouts:\n  sections:\n    news: blog # the \"news\" section is rendered with `blog/list.html.twig` and its pages with `blog/page.html.twig`
\n\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/output/", "url": "https://cecil.app/documentation/configuration/output/", "title": "Output", "summary": "Output directory, formats and post-processing.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Output\nDefines where and in what format pages are rendered.\noutput.dir\nDirectory where rendered pages’ files are saved (_site by default).\noutput:\n dir: _site\noutput.formats\nList of output formats definition, which are used to render pages (e.g. HTML, Atom, RSS, JSON, XML, etc.).\noutput:\n formats:\n - name: <name> # name of the format, e.g.: `html` (required)\n mediatype: <media type> # media type (MIME type), ie: 'text\/html' (optional)\n subpath: <sub path> # sub path, e.g.: `amp` in `path\/amp\/index.html` (optional)\n filename: <file name> # file name, e.g.: `index` in `path\/index.html` (optional)\n extension: <extension> # file extension, e.g.: `html` in `path\/index.html` (required)\n exclude: [<variable>] # don’t apply this format to pages identified by listed variables, e.g.: `[redirect, paginated]` (optional)\nThose formats are used in the output.pagetypeformats configuration and in the output page variable.\nDefault formats\nCecil provides some default formats, which can be overridden in the configuration file: html (default), atom, rss, json, xml, txt, amp, js, webmanifest, xsl, jsonfeed, iframe, oembed.\noutput.pagetypeformats\nIt’s not required to set output variable for each page, as Cecil automatically applies the formats defined for each page type (homepage, page, section, vocabulary and term).\noutput:\n pagetypeformats:\n page: [<format>]\n homepage: [<format>]\n section: [<format>]\n vocabulary: [<format>]\n term: [<format>]\nSeveral formats can be defined for the one type of page. For example the section page type can be automatically rendered in HTML and Atom:\noutput:\n pagetypeformats:\n section: [html, atom]\nTo render a page, Cecil lookup for a template named <layout>.<format>.twig (e.g. page.html.twig)\noutput example\noutput:\n dir: _site\n formats:\n - name: html\n mediatype: text\/html\n filename: index\n extension: html\n - name: atom\n mediatype: application\/xml\n filename: atom\n extension: xml\n exclude: [redirect, paginated]\n pagetypeformats:\n page: [html]\n homepage: [html, atom]\n section: [html, atom]\n vocabulary: [html]\n term: [html, atom]\nPost process\nYou can extend Cecil capabilities with an Output post processor to modify the output files after they have been generated.\n", "content_html": "

Output

\n

Defines where and in what format pages are rendered.

\n

output.dir

\n

Directory where rendered pages’ files are saved (_site by default).

\n
output:\n  dir: _site
\n

output.formats

\n

List of output formats definition, which are used to render pages (e.g. HTML, Atom, RSS, JSON, XML, etc.).

\n
output:\n  formats:\n    - name: <name>            # name of the format, e.g.: `html` (required)\n      mediatype: <media type> # media type (MIME type), ie: 'text/html' (optional)\n      subpath: <sub path>     # sub path, e.g.: `amp` in `path/amp/index.html` (optional)\n      filename: <file name>   # file name, e.g.: `index` in `path/index.html` (optional)\n      extension: <extension>  # file extension, e.g.: `html` in `path/index.html` (required)\n      exclude: [<variable>]   # don’t apply this format to pages identified by listed variables, e.g.: `[redirect, paginated]` (optional)
\n

Those formats are used in the output.pagetypeformats configuration and in the output page variable.

\n

Default formats

\n

Cecil provides some default formats, which can be overridden in the configuration file: html (default), atom, rss, json, xml, txt, amp, js, webmanifest, xsl, jsonfeed, iframe, oembed.

\n

output.pagetypeformats

\n

It’s not required to set output variable for each page, as Cecil automatically applies the formats defined for each page type (homepage, page, section, vocabulary and term).

\n
output:\n  pagetypeformats:\n    page: [<format>]\n    homepage: [<format>]\n    section: [<format>]\n    vocabulary: [<format>]\n    term: [<format>]
\n

Several formats can be defined for the one type of page. For example the section page type can be automatically rendered in HTML and Atom:

\n
output:\n  pagetypeformats:\n    section: [html, atom]
\n\n

output example

\n
output:\n  dir: _site\n  formats:\n    - name: html\n      mediatype: text/html\n      filename: index\n      extension: html\n    - name: atom\n      mediatype: application/xml\n      filename: atom\n      extension: xml\n      exclude: [redirect, paginated]\n  pagetypeformats:\n    page: [html]\n    homepage: [html, atom]\n    section: [html, atom]\n    vocabulary: [html]\n    term: [html, atom]
\n

Post process

\n

You can extend Cecil capabilities with an Output post processor to modify the output files after they have been generated.

\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/cache/", "url": "https://cecil.app/documentation/configuration/cache/", "title": "Cache", "summary": "Assets, templates and translations cache.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Cache\nCache options.\ncache.enabled\nCache is enabled by default (true), but you can disable it with:\ncache:\n enabled: false\nIt’s not recommended to disable the cache for performance reasons.\ncache.dir\nDirectory where cache files are stored (.cache by default).\ncache:\n dir: '.cache'\nThe cache directory is relative to the site directory, but you can use an absolute path: it can be useful to store the cache in a shared directory.\ncache.assets\nAssets cache options.\ncache.assets.ttl\nTime to live of assets cache in seconds (null by default = no expiration).\ncache:\n assets:\n ttl: ~\ncache.assets.remote.ttl\nTime to live of remote assets cache in seconds (7 days by default).\ncache:\n assets:\n remotes:\n ttl: 604800 # 7 days\ncache.templates\nDisables templates cache with false (true by default).\ncache:\n templates: true\nSee templates cache documentation for more details.\ncache.translations\nDisables translations cache with false (true by default).\ncache:\n translations: true\n", "content_html": "

Cache

\n

Cache options.

\n

cache.enabled

\n

Cache is enabled by default (true), but you can disable it with:

\n
cache:\n  enabled: false
\n\n

cache.dir

\n

Directory where cache files are stored (.cache by default).

\n
cache:\n  dir: '.cache'
\n\n

cache.assets

\n

Assets cache options.

\n

cache.assets.ttl

\n

Time to live of assets cache in seconds (null by default = no expiration).

\n
cache:\n  assets:\n    ttl: ~
\n

cache.assets.remote.ttl

\n

Time to live of remote assets cache in seconds (7 days by default).

\n
cache:\n  assets:\n    remotes:\n      ttl: 604800 # 7 days
\n

cache.templates

\n

Disables templates cache with false (true by default).

\n
cache:\n  templates: true
\n\n

cache.translations

\n

Disables translations cache with false (true by default).

\n
cache:\n  translations: true
\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/server/", "url": "https://cecil.app/documentation/configuration/server/", "title": "Server and optimization", "summary": "Local server headers and output optimization.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Server and optimization\nServer\nserver.headers\nYou can define custom HTTP headers, used by the local preview server.\nSince version 8.38.0, the headers option has been moved to the server.headers section.\nserver:\n headers:\n - path: <path> # Relative path, prefixed with a slash. Support \"*\" wildcard.\n headers:\n - key: <key>\n value: \"<value>\"\nIt's useful to test custom Content Security Policy or Cache-Control.\nExample:\nserver:\n headers:\n - path: \/*\n headers:\n - key: X-Frame-Options\n value: \"SAMEORIGIN\"\n - key: X-XSS-Protection\n value: \"1; mode=block\"\n - key: X-Content-Type-Options\n value: \"nosniff\"\n - key: Content-Security-Policy\n value: \"default-src 'self'; object-src 'self'; img-src 'self'\"\n - key: Strict-Transport-Security\n value: \"max-age=31536000; includeSubDomains; preload\"\n - path: \/assets\/*\n headers:\n - key: Cache-Control\n value: \"public, max-age=31536000\"\n - path: \/foo.html\n headers:\n - key: Foo\n value: \"bar\"\n\nOptimize\nThe optimization options allow to enable compression of output files: HTML, CSS, JavaScript and image.\noptimize:\n enabled: false # enables files optimization (`false` by default)\n html:\n enabled: true # enables HTML files optimization\n ext: [html, htm] # supported files extensions\n css:\n enabled: true # enables CSS files optimization\n ext: [css] # supported files extensions\n js:\n enabled: true # enables JavaScript files optimization\n ext: [js] # supported files extensions\n images:\n enabled: true # enables images files optimization\n ext: [jpeg, jpg, png, gif, webp, svg, avif] # supported files extensions\nThis option is disabled by default and can be enabled via:\noptimize: true\nOnce the global option is enabled, the 4 file types will be processed.\nIt is possible to disable each of them via enabled: false and modify processed files extension via ext.\nIt is also possible to enable this option through CLI when using the \"build\" and \"serve\" commands via the --optimize option.\nImages compressor will use these binaries if they are present in the system: JpegOptim, Optipng, Pngquant 2, SVGO, Gifsicle, cwebp and avifenc.\n", "content_html": "

Server and optimization

\n

Server

\n

server.headers

\n

You can define custom HTTP headers, used by the local preview server.

\n\n
server:\n  headers:\n    - path: <path> # Relative path, prefixed with a slash. Support \"*\" wildcard.\n      headers:\n        - key: <key>\n          value: \"<value>\"
\n\n

Example:

\n
server:\n  headers:\n    - path: /*\n      headers:\n        - key: X-Frame-Options\n          value: \"SAMEORIGIN\"\n        - key: X-XSS-Protection\n          value: \"1; mode=block\"\n        - key: X-Content-Type-Options\n          value: \"nosniff\"\n        - key: Content-Security-Policy\n          value: \"default-src 'self'; object-src 'self'; img-src 'self'\"\n        - key: Strict-Transport-Security\n          value: \"max-age=31536000; includeSubDomains; preload\"\n    - path: /assets/*\n      headers:\n        - key: Cache-Control\n          value: \"public, max-age=31536000\"\n    - path: /foo.html\n      headers:\n        - key: Foo\n          value: \"bar\"
\n
\n

Optimize

\n

The optimization options allow to enable compression of output files: HTML, CSS, JavaScript and image.

\n
optimize:\n  enabled: false     # enables files optimization (`false` by default)\n  html:\n    enabled: true    # enables HTML files optimization\n    ext: [html, htm]   # supported files extensions\n  css:\n    enabled: true    # enables CSS files optimization\n    ext: [css]         # supported files extensions\n  js:\n    enabled: true    # enables JavaScript files optimization\n    ext: [js]          # supported files extensions\n  images:\n    enabled: true    # enables images files optimization\n    ext: [jpeg, jpg, png, gif, webp, svg, avif] # supported files extensions
\n

This option is disabled by default and can be enabled via:

\n
optimize: true
\n

Once the global option is enabled, the 4 file types will be processed.
\nIt is possible to disable each of them via enabled: false and modify processed files extension via ext.

\n\n\n
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/override/", "url": "https://cecil.app/documentation/configuration/override/", "title": "Override configuration", "summary": "Override the configuration with environment variables or a CLI option.", "date_published": "2021-05-07T00:00:00+00:00", "date_modified": "2026-10-05T00:00:00+00:00","content_text": "Override configuration\nEnvironment variables\nThe configuration can be overridden through environment variables.\nAt startup, Cecil also attempts to load a .env file from the current site path (the current working directory, or the <path> argument if provided).\n\nIf the .env file does not exist, Cecil continues normally.\nVariables already defined by the shell\/system are preserved.\n\nEach environment variable name must be prefixed with CECIL_ and the configuration key must be set in uppercase.\nFor example, the following command set the website’s baseurl:\nexport CECIL_BASEURL=\"https:\/\/example.com\/\"\nYou can store the same value in a .env file at your project root:\nCECIL_BASEURL=\"https:\/\/example.com\/\"\nCECIL_TITLE=\"My Cecil site\"\nCLI option\nYou can combine multiple configuration files, with the --config option (left-to-right precedence):\nphp cecil.phar --config config-1.yml,config-2.yml", "content_html": "

Override configuration

\n

Environment variables

\n

The configuration can be overridden through environment variables.

\n

At startup, Cecil also attempts to load a .env file from the current site path (the current working directory, or the <path> argument if provided).

\n\n

Each environment variable name must be prefixed with CECIL_ and the configuration key must be set in uppercase.

\n

For example, the following command set the website’s baseurl:

\n
export CECIL_BASEURL=\"https://example.com/\"
\n

You can store the same value in a .env file at your project root:

\n
CECIL_BASEURL=\"https://example.com/\"\nCECIL_TITLE=\"My Cecil site\"
\n

CLI option

\n

You can combine multiple configuration files, with the --config option (left-to-right precedence):

\n
php cecil.phar --config config-1.yml,config-2.yml
", "language": "en" }, { "id": "https://cecil.app/documentation/configuration/locale-codes/", "url": "https://cecil.app/documentation/configuration/locale-codes/", "title": "Locale codes", "summary": "List of available locale codes to use with the languages option.", "date_published": "2020-12-19T00:00:00+00:00", "date_modified": "2026-10-02T00:00:00+00:00","content_text": "Locale codes\nAvailable locale codes (language_COUNTRY) used by the languages option.\n\n\n\nLocale\nCode\n\n\n\n\nAlbanian (Albania)\nsq_AL\n\n\nAlbanian\nsq\n\n\nArabic (Algeria)\nar_DZ\n\n\nArabic (Bahrain)\nar_BH\n\n\nArabic (Egypt)\nar_EG\n\n\nArabic (Iraq)\nar_IQ\n\n\nArabic (Jordan)\nar_JO\n\n\nArabic (Kuwait)\nar_KW\n\n\nArabic (Lebanon)\nar_LB\n\n\nArabic (Libya)\nar_LY\n\n\nArabic (Morocco)\nar_MA\n\n\nArabic (Oman)\nar_OM\n\n\nArabic (Qatar)\nar_QA\n\n\nArabic (Saudi Arabia)\nar_SA\n\n\nArabic (Sudan)\nar_SD\n\n\nArabic (Syria)\nar_SY\n\n\nArabic (Tunisia)\nar_TN\n\n\nArabic (United Arab Emirates)\nar_AE\n\n\nArabic (Yemen)\nar_YE\n\n\nArabic\nar\n\n\nBelarusian (Belarus)\nbe_BY\n\n\nBelarusian\nbe\n\n\nBulgarian (Bulgaria)\nbg_BG\n\n\nBulgarian\nbg\n\n\nCatalan (Spain)\nca_ES\n\n\nCatalan\nca\n\n\nChinese (China)\nzh_CN\n\n\nChinese (Hong Kong)\nzh_HK\n\n\nChinese (Singapore)\nzh_SG\n\n\nChinese (Taiwan)\nzh_TW\n\n\nChinese\nzh\n\n\nCroatian (Croatia)\nhr_HR\n\n\nCroatian\nhr\n\n\nCzech (Czech Republic)\ncs_CZ\n\n\nCzech\ncs\n\n\nDanish (Denmark)\nda_DK\n\n\nDanish\nda\n\n\nDutch (Belgium)\nnl_BE\n\n\nDutch (Netherlands)\nnl_NL\n\n\nDutch\nnl\n\n\nEnglish (Australia)\nen_AU\n\n\nEnglish (Canada)\nen_CA\n\n\nEnglish (India)\nen_IN\n\n\nEnglish (Ireland)\nen_IE\n\n\nEnglish (Malta)\nen_MT\n\n\nEnglish (New Zealand)\nen_NZ\n\n\nEnglish (Philippines)\nen_PH\n\n\nEnglish (Singapore)\nen_SG\n\n\nEnglish (South Africa)\nen_ZA\n\n\nEnglish (United Kingdom)\nen_GB\n\n\nEnglish (United States)\nen_US\n\n\nEnglish\nen\n\n\nEstonian (Estonia)\net_EE\n\n\nEstonian\net\n\n\nFinnish (Finland)\nfi_FI\n\n\nFinnish\nfi\n\n\nFrench (Belgium)\nfr_BE\n\n\nFrench (Canada)\nfr_CA\n\n\nFrench (France)\nfr_FR\n\n\nFrench (Luxembourg)\nfr_LU\n\n\nFrench (Switzerland)\nfr_CH\n\n\nFrench\nfr\n\n\nGerman (Austria)\nde_AT\n\n\nGerman (Germany)\nde_DE\n\n\nGerman (Luxembourg)\nde_LU\n\n\nGerman (Switzerland)\nde_CH\n\n\nGerman\nde\n\n\nGreek (Cyprus)\nel_CY\n\n\nGreek (Greece)\nel_GR\n\n\nGreek\nel\n\n\nHebrew (Israel)\niw_IL\n\n\nHebrew\niw\n\n\nHindi (India)\nhi_IN\n\n\nHungarian (Hungary)\nhu_HU\n\n\nHungarian\nhu\n\n\nIcelandic (Iceland)\nis_IS\n\n\nIcelandic\nis\n\n\nIndonesian (Indonesia)\nin_ID\n\n\nIndonesian\nin\n\n\nIrish (Ireland)\nga_IE\n\n\nIrish\nga\n\n\nItalian (Italy)\nit_IT\n\n\nItalian (Switzerland)\nit_CH\n\n\nItalian\nit\n\n\nJapanese (Japan)\nja_JP\n\n\nJapanese (Japan,JP)\nja_JP_JP\n\n\nJapanese\nja\n\n\nKorean (South Korea)\nko_KR\n\n\nKorean\nko\n\n\nLatvian (Latvia)\nlv_LV\n\n\nLatvian\nlv\n\n\nLithuanian (Lithuania)\nlt_LT\n\n\nLithuanian\nlt\n\n\nMacedonian (Macedonia)\nmk_MK\n\n\nMacedonian\nmk\n\n\nMalay (Malaysia)\nms_MY\n\n\nMalay\nms\n\n\nMaltese (Malta)\nmt_MT\n\n\nMaltese\nmt\n\n\nNorwegian (Norway)\nno_NO\n\n\nNorwegian (Norway,Nynorsk)\nno_NO_NY\n\n\nNorwegian\nno\n\n\nPolish (Poland)\npl_PL\n\n\nPolish\npl\n\n\nPortuguese (Brazil)\npt_BR\n\n\nPortuguese (Portugal)\npt_PT\n\n\nPortuguese\npt\n\n\nRomanian (Romania)\nro_RO\n\n\nRomanian\nro\n\n\nRussian (Russia)\nru_RU\n\n\nRussian\nru\n\n\nSerbian (Bosnia and Herzegovina)\nsr_BA\n\n\nSerbian (Montenegro)\nsr_ME\n\n\nSerbian (Serbia and Montenegro)\nsr_CS\n\n\nSerbian (Serbia)\nsr_RS\n\n\nSerbian\nsr\n\n\nSlovak (Slovakia)\nsk_SK\n\n\nSlovak\nsk\n\n\nSlovenian (Slovenia)\nsl_SI\n\n\nSlovenian\nsl\n\n\nSpanish (Argentina)\nes_AR\n\n\nSpanish (Bolivia)\nes_BO\n\n\nSpanish (Chile)\nes_CL\n\n\nSpanish (Colombia)\nes_CO\n\n\nSpanish (Costa Rica)\nes_CR\n\n\nSpanish (Dominican Republic)\nes_DO\n\n\nSpanish (Ecuador)\nes_EC\n\n\nSpanish (El Salvador)\nes_SV\n\n\nSpanish (Guatemala)\nes_GT\n\n\nSpanish (Honduras)\nes_HN\n\n\nSpanish (Mexico)\nes_MX\n\n\nSpanish (Nicaragua)\nes_NI\n\n\nSpanish (Panama)\nes_PA\n\n\nSpanish (Paraguay)\nes_PY\n\n\nSpanish (Peru)\nes_PE\n\n\nSpanish (Puerto Rico)\nes_PR\n\n\nSpanish (Spain)\nes_ES\n\n\nSpanish (United States)\nes_US\n\n\nSpanish (Uruguay)\nes_UY\n\n\nSpanish (Venezuela)\nes_VE\n\n\nSpanish\nes\n\n\nSwedish (Sweden)\nsv_SE\n\n\nSwedish\nsv\n\n\nThai (Thailand)\nth_TH\n\n\nThai (Thailand,TH)\nth_TH_TH\n\n\nThai\nth\n\n\nTurkish (Turkey)\ntr_TR\n\n\nTurkish\ntr\n\n\nUkrainian (Ukraine)\nuk_UA\n\n\nUkrainian\nuk\n\n\nVietnamese (Vietnam)\nvi_VN\n\n\nVietnamese\nvi\n\n\n", "content_html": "

Locale codes

\n

Available locale codes (language_COUNTRY) used by the languages option.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
LocaleCode
Albanian (Albania)sq_AL
Albaniansq
Arabic (Algeria)ar_DZ
Arabic (Bahrain)ar_BH
Arabic (Egypt)ar_EG
Arabic (Iraq)ar_IQ
Arabic (Jordan)ar_JO
Arabic (Kuwait)ar_KW
Arabic (Lebanon)ar_LB
Arabic (Libya)ar_LY
Arabic (Morocco)ar_MA
Arabic (Oman)ar_OM
Arabic (Qatar)ar_QA
Arabic (Saudi Arabia)ar_SA
Arabic (Sudan)ar_SD
Arabic (Syria)ar_SY
Arabic (Tunisia)ar_TN
Arabic (United Arab Emirates)ar_AE
Arabic (Yemen)ar_YE
Arabicar
Belarusian (Belarus)be_BY
Belarusianbe
Bulgarian (Bulgaria)bg_BG
Bulgarianbg
Catalan (Spain)ca_ES
Catalanca
Chinese (China)zh_CN
Chinese (Hong Kong)zh_HK
Chinese (Singapore)zh_SG
Chinese (Taiwan)zh_TW
Chinesezh
Croatian (Croatia)hr_HR
Croatianhr
Czech (Czech Republic)cs_CZ
Czechcs
Danish (Denmark)da_DK
Danishda
Dutch (Belgium)nl_BE
Dutch (Netherlands)nl_NL
Dutchnl
English (Australia)en_AU
English (Canada)en_CA
English (India)en_IN
English (Ireland)en_IE
English (Malta)en_MT
English (New Zealand)en_NZ
English (Philippines)en_PH
English (Singapore)en_SG
English (South Africa)en_ZA
English (United Kingdom)en_GB
English (United States)en_US
Englishen
Estonian (Estonia)et_EE
Estonianet
Finnish (Finland)fi_FI
Finnishfi
French (Belgium)fr_BE
French (Canada)fr_CA
French (France)fr_FR
French (Luxembourg)fr_LU
French (Switzerland)fr_CH
Frenchfr
German (Austria)de_AT
German (Germany)de_DE
German (Luxembourg)de_LU
German (Switzerland)de_CH
Germande
Greek (Cyprus)el_CY
Greek (Greece)el_GR
Greekel
Hebrew (Israel)iw_IL
Hebrewiw
Hindi (India)hi_IN
Hungarian (Hungary)hu_HU
Hungarianhu
Icelandic (Iceland)is_IS
Icelandicis
Indonesian (Indonesia)in_ID
Indonesianin
Irish (Ireland)ga_IE
Irishga
Italian (Italy)it_IT
Italian (Switzerland)it_CH
Italianit
Japanese (Japan)ja_JP
Japanese (Japan,JP)ja_JP_JP
Japaneseja
Korean (South Korea)ko_KR
Koreanko
Latvian (Latvia)lv_LV
Latvianlv
Lithuanian (Lithuania)lt_LT
Lithuanianlt
Macedonian (Macedonia)mk_MK
Macedonianmk
Malay (Malaysia)ms_MY
Malayms
Maltese (Malta)mt_MT
Maltesemt
Norwegian (Norway)no_NO
Norwegian (Norway,Nynorsk)no_NO_NY
Norwegianno
Polish (Poland)pl_PL
Polishpl
Portuguese (Brazil)pt_BR
Portuguese (Portugal)pt_PT
Portuguesept
Romanian (Romania)ro_RO
Romanianro
Russian (Russia)ru_RU
Russianru
Serbian (Bosnia and Herzegovina)sr_BA
Serbian (Montenegro)sr_ME
Serbian (Serbia and Montenegro)sr_CS
Serbian (Serbia)sr_RS
Serbiansr
Slovak (Slovakia)sk_SK
Slovaksk
Slovenian (Slovenia)sl_SI
Sloveniansl
Spanish (Argentina)es_AR
Spanish (Bolivia)es_BO
Spanish (Chile)es_CL
Spanish (Colombia)es_CO
Spanish (Costa Rica)es_CR
Spanish (Dominican Republic)es_DO
Spanish (Ecuador)es_EC
Spanish (El Salvador)es_SV
Spanish (Guatemala)es_GT
Spanish (Honduras)es_HN
Spanish (Mexico)es_MX
Spanish (Nicaragua)es_NI
Spanish (Panama)es_PA
Spanish (Paraguay)es_PY
Spanish (Peru)es_PE
Spanish (Puerto Rico)es_PR
Spanish (Spain)es_ES
Spanish (United States)es_US
Spanish (Uruguay)es_UY
Spanish (Venezuela)es_VE
Spanishes
Swedish (Sweden)sv_SE
Swedishsv
Thai (Thailand)th_TH
Thai (Thailand,TH)th_TH_TH
Thaith
Turkish (Turkey)tr_TR
Turkishtr
Ukrainian (Ukraine)uk_UA
Ukrainianuk
Vietnamese (Vietnam)vi_VN
Vietnamesevi
", "language": "en" } ] }