Dokumentation on Blowfish

Willkommen bei Blowfish

Mon, 01 Jan 0001 00:00:00 +0000

Blowfish ist vollgepackt mit unzähligen Funktionen.

Das ursprüngliche Ziel von Blowfish war es, ein Theme zu entwickeln, das einfach und leichtgewichtig ist. Das Theme ist ein Fork von Congo und erweitert dessen ursprüngliche Vision.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Folgen Sie einfach dem standardmäßigen Hugo Schnellstart-Verfahren, um schnell loszulegen.

Detaillierte Installationsanweisungen finden Sie unten. Anweisungen zum Aktualisieren des Themes sind ebenfalls verfügbar.

Installation
#

Diese Anweisungen bringen Sie von einem komplett leeren Zustand mit Hugo und Blowfish zum Laufen. Die meisten der in diesem Leitfaden erwähnten Abhängigkeiten können mit dem Paketmanager Ihrer Wahl für Ihre Plattform installiert werden.

Erste Schritte

Mon, 01 Jan 0001 00:00:00 +0000

Dieser Abschnitt setzt voraus, dass Sie das Blowfish-Theme bereits installiert haben.

Wir haben gerade ein CLI-Tool veröffentlicht, das Ihnen beim Einstieg mit Blowfish hilft. Es unterstützt Sie bei Installation und Konfiguration. Installieren Sie das CLI-Tool global mit:

Konfiguration

Mon, 01 Jan 0001 00:00:00 +0000

Blowfish ist ein hochgradig anpassbares Theme und nutzt einige der neuesten Hugo-Funktionen, um die Konfiguration zu vereinfachen.

Das Theme wird mit einer Standardkonfiguration geliefert, die Sie mit einem einfachen Blog oder einer statischen Website zum Laufen bringt.

Homepage-Layout

Mon, 01 Jan 0001 00:00:00 +0000

Blowfish bietet ein vollständig flexibles Homepage-Layout. Es gibt zwei Hauptvorlagen zur Auswahl mit zusätzlichen Einstellungen zur Anpassung des Designs. Alternativ können Sie auch Ihre eigene Vorlage bereitstellen und die vollständige Kontrolle über den Homepage-Inhalt haben.

Shortcodes

Mon, 01 Jan 0001 00:00:00 +0000

Zusätzlich zu allen Standard-Hugo-Shortcodes fügt Blowfish einige zusätzliche für erweiterte Funktionalität hinzu.

Alert
#

alert gibt seinen Inhalt als stilisierte Nachrichtenbox innerhalb Ihres Artikels aus. Es ist nützlich, um auf wichtige Informationen aufmerksam zu machen, die der Leser nicht übersehen sollte.

Front Matter

Mon, 01 Jan 0001 00:00:00 +0000

Zusätzlich zu den Standard-Hugo-Front-Matter-Parametern fügt Blowfish eine Reihe zusätzlicher Optionen hinzu, um die Darstellung einzelner Artikel anzupassen. Alle verfügbaren Theme-Front-Matter-Parameter sind unten aufgelistet.

Die Standardwerte der Front-Matter-Parameter werden von der Basiskonfiguration des Themes geerbt, sodass Sie diese Parameter nur in Ihrem Front Matter angeben müssen, wenn Sie die Standardwerte überschreiben möchten.

Mehrere Autoren

Mon, 01 Jan 0001 00:00:00 +0000

Einige Websites haben mehr als einen Autor, der Inhalte beisteuert, und benötigen daher mehr als einen einzelnen Standardautor für die gesamte Website. Für diese Anwendungsfälle ermöglicht Blowfish den Benutzern, die Liste der Autoren mithilfe der Funktion für mehrere Autoren zu erweitern.

Partials

Mon, 01 Jan 0001 00:00:00 +0000

Analytics
#

Blowfish bietet integrierte Unterstützung für Fathom Analytics, Google Analytics und Umami Analytics. Fathom ist eine kostenpflichtige Alternative zu Google Analytics, die die Privatsphäre der Benutzer respektiert.

Vorschaubilder

Mon, 01 Jan 0001 00:00:00 +0000

Vorschaubilder
#

Blowfish wurde erweitert, um das Hinzufügen visueller Unterstützung zu Ihren Beiträgen einfach zu machen. Dazu müssen Sie lediglich eine Bilddatei (fast alle Formate werden unterstützt, aber wir empfehlen .png oder .jpg), die mit feature* beginnt, im Hauptverzeichnis Ihres Artikels platzieren, wie im folgenden Beispiel gezeigt.

Inhaltsbeispiele

Mon, 01 Jan 0001 00:00:00 +0000

Wenn Sie die Dokumentation der Reihe nach gelesen haben, sollten Sie jetzt alle Funktionen und Konfigurationen kennen, die in Blowfish verfügbar sind. Diese Seite ist darauf ausgelegt, alles zusammenzuführen und einige ausgearbeitete Beispiele anzubieten, die Sie möglicherweise in Ihrem Hugo-Projekt verwenden möchten.

Serien

Mon, 01 Jan 0001 00:00:00 +0000

Blowfish bietet eine Funktion, um mehrere Artikel unter einer “Serie” zu gruppieren. Das Platzieren eines Artikels in einer Serie zeigt die restlichen Artikel der Serie auf jeder Einzelseite an und ermöglicht eine schnelle Navigation zwischen ihnen. Sie können ein Beispiel dafür oben sehen.

Erweiterte Anpassung

Mon, 01 Jan 0001 00:00:00 +0000

Es gibt viele Möglichkeiten, erweiterte Änderungen an Blowfish vorzunehmen. Lesen Sie unten, um mehr darüber zu erfahren, was angepasst werden kann und wie Sie das gewünschte Ergebnis am besten erreichen.

Hosting & Bereitstellung

Mon, 01 Jan 0001 00:00:00 +0000

Es gibt viele Möglichkeiten, Ihre mit Blowfish erstellte Hugo-Website bereitzustellen. Das Theme ist so konzipiert, dass es in fast jedem Bereitstellungsszenario flexibel einsetzbar ist.

Blowfish verwendet durchgehend relative URLs im gesamten Theme. Dies ermöglicht es, Websites einfach in Unterordnern und auf Hosts wie GitHub Pages bereitzustellen. Normalerweise ist keine spezielle Konfiguration erforderlich, solange der baseURL-Parameter in der hugo.toml-Datei korrekt konfiguriert wurde.

Firebase: Aufrufe & Likes

Mon, 01 Jan 0001 00:00:00 +0000

Um dynamische Daten auf Ihrer Website zu unterstützen, haben wir die Integration von Firebase hinzugefügt. Dies ermöglicht es Ihnen, die Aufrufe-Funktion über Listen und Beiträge hinweg zu nutzen.

Gehen Sie zur Firebase-Website und erstellen Sie ein kostenloses Konto
Erstellen Sie ein neues Projekt
Wählen Sie den Analytics-Standort
Richten Sie Firebase in Blowfish ein, indem Sie die Variablen für Ihr Projekt abrufen und sie in der params.toml-Datei setzen. Weitere Details finden Sie auf dieser Seite. Unten finden Sie ein Beispiel der Datei, die Firebase bereitstellt. Beachten Sie die Parameter innerhalb des FirebaseConfig-Objekts.

// Import the functions you need from the SDKs you need
import { initializeApp } from "firebase/app";
import { getAnalytics } from "firebase/analytics";
// TODO: Add SDKs for Firebase products that you want to use
// https://firebase.google.com/docs/web/setup#available-libraries

// Your web app's Firebase configuration
// For Firebase JS SDK v7.20.0 and later, measurementId is optional
const firebaseConfig = {
 apiKey: "AIzaSyB5tqlqDky77Vb4Tc4apiHV4hRZI18KGiY",
 authDomain: "blowfish-21fff.firebaseapp.com",
 projectId: "blowfish-21fff",
 storageBucket: "blowfish-21fff.appspot.com",
 messagingSenderId: "60108104191",
 appId: "1:60108104191:web:039842ebe1370698b487ca",
 measurementId: "G-PEDMYR1V0K"
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);
const analytics = getAnalytics(app);

Firestore einrichten - Wählen Sie Build und öffnen Sie Firestore. Erstellen Sie eine neue Datenbank und wählen Sie den Start im Produktionsmodus. Wählen Sie den Serverstandort und warten Sie. Sobald dies gestartet ist, müssen Sie die Regeln konfigurieren. Kopieren Sie einfach die Datei unten und drücken Sie Veröffentlichen. Diese Regeln stellen sicher, dass Aufrufe nur um 1 erhöht werden können und Likes nur um +1 oder -1 geändert werden können (und nie unter 0 fallen).

rules_version = '2';
service cloud.firestore {
 match /databases/{database}/documents {
 // Views - read anyone, only increment by 1
 match /views/{document} {
 allow read: if request.auth != null;
 allow create: if request.auth != null
 && request.resource.data.keys().hasOnly(['views'])
 && request.resource.data.views == 1;
 allow update: if request.auth != null
 && request.resource.data.diff(resource.data).affectedKeys().hasOnly(['views'])
 && request.resource.data.views == resource.data.views + 1;
 }

 // Likes - read anyone, only +1 or -1
 match /likes/{document} {
 allow read: if request.auth != null;
 allow create: if request.auth != null
 && request.resource.data.keys().hasOnly(['likes'])
 && request.resource.data.likes == 1;
 allow update: if request.auth != null
 && request.resource.data.diff(resource.data).affectedKeys().hasOnly(['likes'])
 && (request.resource.data.likes == resource.data.likes + 1
 || request.resource.data.likes == resource.data.likes - 1)
 && request.resource.data.likes >= 0;
 }

 // Deny everything else
 match /{document=**} {
 allow read, write: if false;
 }
 }
}

Anonyme Autorisierung aktivieren - Wählen Sie Build und öffnen Sie Authentication. Wählen Sie Erste Schritte, klicken Sie auf Anonym und aktivieren Sie es, speichern.
Fertig - Sie können jetzt Aufrufe und Likes in Blowfish für alle (oder bestimmte) Artikel aktivieren.

Dokumentation on Blowfish

Willkommen bei Blowfish

Installation

Installation #

Erste Schritte

Konfiguration

Homepage-Layout

Shortcodes

Alert #

Front Matter

Mehrere Autoren

Partials

Analytics #

Vorschaubilder

Vorschaubilder #

Inhaltsbeispiele

Serien

Erweiterte Anpassung

Hosting & Bereitstellung

Firebase: Aufrufe & Likes

Installation
#

Alert
#

Analytics
#

Vorschaubilder
#