54 lines
2.7 KiB
Markdown
54 lines
2.7 KiB
Markdown
|
---
|
||
|
|
date: 2016-04-09T16:50:16+02:00
|
||
|
|
title: Configuration
|
||
|
|
weight: 20
|
||
|
|
---
|
||
|
|
|
||
|
|
## Paramètres globaux du site
|
||
|
|
|
||
|
|
En plus de la [configuration globale d'Hugo](https://gohugo.io/overview/configuration/), **Hugo-theme-learn** vous permet de définir les paramètres suivant dans votre fichier `config.toml` (ci-dessous sont affichées les valeurs par défaut).
|
||
|
|
|
||
|
|
Notez que certains de ces paramètres sont expliqués en détails dans d'autres sections de cette documentation.
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[params]
|
||
|
|
# L'URL préfixe pour éditer la page courante. Ce paramètre affichera un bouton "Modifier cette page" on haut de de chacune des pages.
|
||
|
|
# Pratique pour donner les possibilité à vos utilisateurs de créer une merge request pour votre doc.
|
||
|
|
# Allez voir le fichier config.toml de cette documentation pour avoir un exemple.
|
||
|
|
editURL = ""
|
||
|
|
# Autheur du site, est utilisé dans les informations meta
|
||
|
|
author = ""
|
||
|
|
# Description du site, est utilisé dans les informations meta
|
||
|
|
description = ""
|
||
|
|
# Affiche une icône lorsque la page a été visitée
|
||
|
|
showVisitedLinks = false
|
||
|
|
# Désactive la fonction de recherche. Une valeur à true cache la barre de recherche.
|
||
|
|
disableSearch = false
|
||
|
|
# Par défaut, le cache Javascript et CSS est automatiquement vidé lorsqu'une nouvelle version du site est générée.
|
||
|
|
# Utilisez ce paramètre lorsque vous voulez désactiver ce comportement (c'est parfois incompatible avec certains proxys)
|
||
|
|
disableAssetsBusting = false
|
||
|
|
# Utilisez ce paramètre pour désactiver le bouton copy-to-clipboard pour le code formatté sur une ligne.
|
||
|
|
disableInlineCopyToClipBoard = false
|
||
|
|
# Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
|
||
|
|
disableShortcutsTitle = false
|
||
|
|
# Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
|
||
|
|
disableLanguageSwitchingButton = false
|
||
|
|
# Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight"
|
||
|
|
ordersectionsby = "weight"
|
||
|
|
# Utilisez ce paramètre pour modifier le schéma de couleur du site. Les valeurs par défaut sont "red", "blue", "green".
|
||
|
|
themeVariant = ""
|
||
|
|
```
|
||
|
|
|
||
|
|
## Activer la recherche {#activer-recherche}
|
||
|
|
|
||
|
|
Si ce n'est pas déjà présent, ajoutez les lignes suivantes dans le fichier `config.toml`.
|
||
|
|
|
||
|
|
```toml
|
||
|
|
[outputs]
|
||
|
|
home = [ "HTML", "RSS", "JSON"]
|
||
|
|
```
|
||
|
|
|
||
|
|
Le thème *Learn* utilise les dernières amélioraions d'Hugo pour générer un fichier d'index JSON, prêt à être consommé par le moteur de recherche lunr.js.
|
||
|
|
|
||
|
|
> Hugo génère lunrjs index.json à la racine du dossier `public`.
|
||
|
|
> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.
|