hugo book herunterladen - hugo book -Quellcode herunterladen

hugo book

Anderer Quellcode

1.0.0

Herunterladen

Hugo-Buchthema – HOT-Gabel

Hugo-Dokumentationsthema so einfach wie ein einfaches Buch

Screenshot

Merkmale

Sauberes, einfaches Design
Mobilfreundlich
Anpassbar
Entwickelt, um andere Layouts nicht zu beeinträchtigen
Null Erstkonfiguration

Anforderungen

Hugo 0,43 oder höher
Hugo erweiterte Version, lesen Sie hier mehr

Installation

Navigieren Sie zum Stammverzeichnis Ihrer Hugo-Website und führen Sie Folgendes aus:

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

Führen Sie dann „hugo“ aus (oder legen Sie theme: book in der Konfigurationsdatei fest).

hugo server --theme book

Speisekarte

Dateibaummenü (Standard)

Standardmäßig stellt das Design Seiten aus dem Abschnitt content/docs als Menü in einer Baumstruktur dar.
Sie können title und weight für die Vorderseite der Seiten festlegen, um die Reihenfolge und Titel im Menü anzupassen.

Leaf-Bundle-Menü

Sie können auch das Blattbündel und den Inhalt seiner index.md als Menü verwenden.

Vorausgesetzt, Sie haben diese Dateistruktur

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

Erstellen Sie die Datei content/docs/menu/index.md mit Inhalt

 ---headless: true---- [Buchbeispiel](/docs/)
  - [Seite Eins](/docs/page-one)
  - [Seite Zwei](/docs/page-two)- [Blog](/posts)

Und aktivieren Sie es durch die Einstellungen BookMenuBundle: /docs/menu in der Site-Konfiguration

Beispielmenü
Beispielkonfigurationsdatei
Blattbündel

Blog

Einfaches Blog, das für posts unterstützt wird

Konfiguration

Site-Konfiguration

Es gibt einige Konfigurationsoptionen, die Sie Ihrer Datei config.yml|json|toml hinzufügen können

 # (Optional) Setzen Sie dies auf „true“, wenn Sie Großbuchstaben in Dateinamen verwendendisablePathToLower: true# (Optional) Setzen Sie dies auf „true“, um das Datum „Letzte Änderung von“ und Git-Autor#-Informationen auf Seiten vom Typ „doc“ zu aktivieren.enableGitInfo: true# (Warnungen) Das Theme ist für die Verwendung in der Dokumentation gedacht und gibt daher keine Taxonomie wieder.# Sie können entsprechende Warnungen mit der folgenden Konfiguration ausblendendisableKinds: ["taxonomy", "taxonomyTerm"]params: # (Optional, Standardwert true) Inhaltsverzeichnis global anzeigen oder ausblenden
  # Sie können diesen Parameter auch pro Seite im Titelblatt angeben
  BookShowToC: wahr

  # (Optional, standardmäßig keine) Legen Sie das Blattbündel so fest, dass es als Seitenmenü gerendert wird
  # Wenn nicht angegeben, werden Dateistruktur und Gewichtungen verwendet
  BookMenuBundle: /menu

  # (Optional, Standarddokumente) Geben Sie den Inhaltsabschnitt an, der als Menü gerendert werden soll
  # Sie können den Wert auch auf „*“ setzen, um alle Abschnitte im Menü darzustellen
  BookSection: Dokumente

  # Dieser Wert ist ein Duplikat von $link-color, um aktive Links im Menübündelmodus hervorzuheben
  # BookMenuBundleActiveLinkColor: #004ed0

  # JS-Skripte in Seiten einbinden. Standardmäßig deaktiviert.
  # – Seitenmenü während der Navigation an derselben Bildlaufposition belassen
  BookEnableJS: wahr

  # Legen Sie den Speicherort des Quell-Repositorys fest.
  # Wird für die Links „Zuletzt geändert“ und „Diese Seite bearbeiten“ verwendet.
  BookRepo: https://github.com/alex-shpak/hugo-book

  # Aktivieren Sie die Links „Diese Seite bearbeiten“ für den Seitentyp „Dokument“.
  # Standardmäßig deaktiviert. Zum Aktivieren den Kommentar entfernen. Erfordert den Parameter „BookRepo“.
  # Der Pfad muss auf das Verzeichnis „content“ des Repos verweisen.
  BookEditPath: edit/master/exampleSite/content

Seitenkonfiguration

Sie können pro Seite im Titelblatt zusätzliche Parameter angeben

 ---# Legen Sie den Typ auf „docs“ fest, wenn Sie die Seite außerhalb des konfigurierten Abschnitts rendern möchten oder wenn Sie einen anderen Abschnitt als „docs“ rendern möchten. Typ: docs# Legen Sie die Seitenstärke fest, um Elemente im Dateibaummenü neu anzuordnen (wenn BookMenuBundle nicht festgelegt)weight: 10# (Optional) Legen Sie fest, dass die Seite als flacher Abschnitt im Dateibaummenü markiert wird (wenn BookMenuBundle nicht festgelegt ist)bookFlatSection: true# (Optional) Legen Sie fest, dass das Inhaltsverzeichnis ausgeblendet wird, überschreibt globale Werte valuebookShowToC: false---

Teiltöne

Es gibt einige leere Teiltöne, die Sie in layouts/partials/

Teilweise	Platzierung
`layouts/partials/docs/inject/head.html`	Vor dem Schließen `<head>` -Tags
`layouts/partials/docs/inject/body.html`	Vor dem Schließen `<body>` -Tags
`layouts/partials/docs/inject/menu-before.html`	Am Anfang des Menüblocks `<nav>`
`layouts/partials/docs/inject/menu-after.html`	Am Ende des Menüblocks `<nav>`