hugo book

Thème du livre Hugo - Fourchette CHAUDE

Thème de documentation Hugo aussi simple qu'un livre ordinaire

Caractéristiques

• Conception simple et épurée

• Adapté aux appareils mobiles

• Personnalisable

• Conçu pour ne pas interférer avec d'autres mises en page

• Zéro configuration initiale

Exigences

• Hugo 0,43 ou supérieur

• Version étendue de Hugo, en savoir plus ici

Installation

Accédez à la racine de votre site Web Hugo et exécutez :

git submodule add https://github.com/alex-shpak/hugo-book themes/book

Ensuite, lancez Hugo (ou définissez theme: book dans le fichier de configuration)

hugo server --theme book

Menu

Menu arborescence de fichiers (par défaut)

Par défaut, le thème affichera les pages de la section content/docs sous forme de menu dans une arborescence.
Vous pouvez définir title et weight au début des pages pour ajuster l'ordre et les titres dans le menu.

Menu de paquets de feuilles

Vous pouvez également utiliser le bundle de feuilles et le contenu de son index.md comme menu.

Étant donné que vous avez cette structure de fichiers

├── content
│   ├── docs
│   │   ├── page-one.md
│   │   └── page-two.md
│   └── posts
│       ├── post-one.md
│       └── post-two.md

Créer le fichier content/docs/menu/index.md avec le contenu

 ---sans tête : vrai---- [Exemple de livre](/docs/)
  - [Page 1](/docs/page-one)
  - [Page deux](/docs/page-two)- [Blog](/posts)

Et activez-le par les paramètres BookMenuBundle: /docs/menu dans la configuration du site

• Exemple de menu

• Exemple de fichier de configuration

• Faisceaux de feuilles

Blogue

Blog simple pris en charge pour posts de section

Configuration

Configuration du site

Il existe quelques options de configuration que vous pouvez ajouter à votre fichier config.yml|json|toml

 # (Facultatif) Définissez ceci sur true si vous utilisez des lettres majuscules dans les noms de fichiers. (Avertissements) Le thème est destiné à la documentation, car il ne restitue pas la taxonomie.# Vous pouvez masquer l'avertissement associé avec la configuration ci-dessousdisableKinds : ["taxonomie", "taxonomyTerm"]params : # (Facultatif, vrai par défaut) Afficher ou masquer la table des matières globalement
  # Vous pouvez également spécifier ce paramètre par page en introduction
  BookShowToC : vrai

  # (Facultatif, aucun par défaut) Définir le paquet de feuilles pour qu'il soit rendu dans le menu latéral
  # Lorsque la structure et les poids du fichier ne sont pas spécifiés, ils seront utilisés
  LivreMenuBundle : /menu

  # (Facultatif, documents par défaut) Spécifiez la section de contenu à afficher sous forme de menu
  # Vous pouvez également définir la valeur sur "*" pour afficher toutes les sections dans le menu
  Section Livre : docs

  # Cette valeur est une copie de $link-color pour mettre en surbrillance le lien actif en mode bundle de menus
  # BookMenuBundleActiveLinkColor : #004ed0

  # Incluez des scripts JS dans les pages. Désactivé par défaut.
  # - Gardez le menu latéral sur la même position de défilement pendant la navigation
  BookEnableJS : vrai

  # Définir l'emplacement du référentiel source.
  # Utilisé pour les liens « Dernière modification » et « Modifier cette page ».
  BookRepo : https://github.com/alex-shpak/hugo-book

  # Activez les liens "Modifier cette page" pour le type de page "doc".
  # Désactivé par défaut. Décommentez pour activer. Nécessite le paramètre 'BookRepo'.
  # Le chemin doit pointer vers le répertoire 'content' du dépôt.
  BookEditPath : modifier/maître/exempleSite/contenu

Configuration des pages

Vous pouvez spécifier des paramètres supplémentaires par page dans les préambules

 ---# Définissez le type sur 'docs' si vous souhaitez afficher la page en dehors de la section configurée ou si vous affichez une section autre que le type 'docs' : docs# Définissez le poids de la page pour réorganiser les éléments dans le menu de l'arborescence des fichiers (si BookMenuBundle non défini)weight : 10# (Facultatif) Défini pour marquer la page comme section plate dans le menu de l'arborescence de fichiers (si BookMenuBundle n'est pas défini)bookFlatSection : true# (Facultatif) Défini pour masquer la table des matières, remplace valeur globalebookShowToC : faux ---

Partiels

Il existe quelques partiels vides que vous pouvez remplacer dans layouts/partials/

Partiel	Placement
layouts/partials/docs/inject/head.html	Avant de fermer la balise <head>
layouts/partials/docs/inject/body.html	Avant de fermer la balise <body>
layouts/partials/docs/inject/menu-before.html	Au début du bloc de menu <nav>
layouts/partials/docs/inject/menu-after.html	À la fin du bloc de menu <nav>

Contribuer

Les contributions sont les bienvenues et j'examinerai et considérerai les demandes de tirage.
Les principaux objectifs sont :

• Restez simple

• Conserver une configuration par défaut minimale (ou nulle)

• Évitez les interférences avec les mises en page définies par l'utilisateur

N'hésitez pas à ouvrir un problème s'il vous manque une option de configuration ou de personnalisation.

Licence

MIT