# Configuration ## Aperçu La configuration du site web est définie dans un fichier [YAML](https://en.wikipedia.org/wiki/YAML) nommé `cecil.yml` ou `config.yml`, stocké à la racine : ```plaintext └─ cecil.yml ``` Cecil propose de nombreuses options de configuration, mais ses [valeurs par défaut](https://github.com/Cecilapp/Cecil/blob/master/config/default.php) sont souvent suffisantes. Un nouveau site ne nécessite que ces paramètres : ```yaml title: "My new Cecil site" baseurl: https://mywebsite.com/ description: "Site description" ``` La documentation ci-dessous couvre toutes les options de configuration prises en charge par Cecil. ## Options ### title Titre principal du site. ```yaml title: "" ``` ### baseline Description courte (~ 20 caractères). ```yaml baseline: "" ``` ### baseurl URL de base. ```yaml baseurl: ``` _Exemple :_ ```yaml baseurl: http://localhost:8000/ ``` :::important `baseurl` doit se terminer par un slash final (`/`). ::: ### canonicalurl Si la valeur est `true`, la fonction [`url()`](3-Templates.md#url) renverra l’URL absolue (`false` par défaut). ```yaml canonicalurl: # false by default ``` ### description Description du site (~ 250 caractères). ```yaml description: "" ``` ### menus Les menus sont utilisés pour créer des [liens de navigation dans les templates](3-Templates.md#site-menus). Un menu est composé d’un identifiant unique et des propriétés des entrées (nom, URL, poids). ```yaml menus: : - id: # unique identifier (required) name: "" # name displayed in templates url: # relative or absolute URL weight: # integer value used to sort entries (lighter first) ``` _Exemple :_ ```yaml menus: main: - id: about name: "About" url: /about/ weight: 1 footer: - id: author name: The author url: https://arnaudligny.fr weight: 99 ``` :::info Un menu `main` est créé automatiquement avec l’entrée de la page d’accueil et toutes les entrées de sections ([Voir la gestion du contenu](2-Content.md)). ::: :::tip Une page peut être ajoutée à un menu en définissant la variable [`menu`](2-Content.md#menu) dans son front matter. ::: #### Surcharger une entrée Une entrée de menu de page peut être surchargée : utilisez l’ID de la page comme `id`. _Exemple :_ ```yaml menus: main: - id: index name: "My amazing homepage!" weight: 1 ``` #### Désactiver une entrée Une entrée de menu peut être désactivée avec `enabled: false`. _Exemple :_ ```yaml menus: main: - id: about enabled: false ``` ### taxonomies Liste des vocabulaires, associant une valeur au pluriel à une valeur au singulier. ```yaml taxonomies: : ``` _Exemple :_ ```yaml taxonomies: categories: category tags: tag ``` Vous pouvez ensuite utiliser ces vocabulaires dans le [front matter](2-Content.md#taxonomie) de votre contenu. :::warning Depuis la ++version 8.37.0++, les vocabulaires par défaut `category` et `tag` ont été supprimés. Vous devez les définir dans le fichier de configuration si vous souhaitez les utiliser. ::: :::tip Un vocabulaire peut être désactivé avec la valeur spéciale `disabled`. Exemple : `tags: disabled`. ::: ### theme Thème à utiliser, ou liste de thèmes. ```yaml theme: # theme name # or theme: - # theme name - ``` :::info Le premier thème surcharge les suivants, et ainsi de suite. ::: _Exemples :_ ```yaml theme: hyde ``` ```yaml theme: - serviceworker - hyde ``` :::info Voir les [thèmes sur GitHub](https://github.com/Cecilapp?q=theme#org-repositories) ou la [section thèmes](https://cecil.app/themes/) du site. ::: ### date Format de date et fuseau horaire. ```yaml date: format: # date format (optional, `F j, Y` by default) timezone: # date timezone (optional, local time zone by default) ``` - `format` : spécificateur de format de [date PHP](https://php.net/date) - `timezone` : voir les [fuseaux horaires](https://php.net/timezones) _Exemple :_ ```yaml date: format: 'j F, Y' timezone: 'Europe/Paris' ``` ### language Langue principale, définie par son code. ```yaml language:

 # unique code (`en` by default)
```

Par défaut, seuls les chemins des pages des autres [langues](#languages) sont préfixés par leur code de langue, mais vous pouvez préfixer le chemin des pages de la langue principale avec l’option suivante :

```yaml
#language: 
language:
  code: 
  prefix: true
```

:::info
Quand `prefix` est défini à `true`, un alias est automatiquement créé pour la page d’accueil afin de rediriger de `/` vers `//`.
:::

### languages

Options des langues disponibles, utilisées pour la localisation des [pages](2-Content.md#multilingual) et des [templates](3-Templates.md#localization).

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

_Exemple :_

```yaml
language: en
languages:
  - code: en
    name: English
    locale: en_EN
  - code: fr
    name: Français
    locale: fr_FR
```

:::info
Une [liste des codes de locale](configuration/locale-codes.md) est disponible si nécessaire.
:::

#### Localiser

Pour localiser des options de configuration, vous devez les stocker sous la clé `config` de la langue.

_Exemple :_

```yaml
title: "Cecil in english"
languages:
  - code: en
    name: English
    locale: en_US
  - code: fr
    name: Français
    locale: fr_FR
    config:
      title: "Cecil en français"
```

:::info
Dans les [templates](3-Templates.md), vous pouvez accéder à une option avec `{{ site.