dbrun/blowfish

Fork 0

mirror of https://github.com/nunocoracao/blowfish.git synced 2026-01-30 16:31:52 +01:00

Files

rxchi1d 6f6323ff55 chore(docs): align Hugo minimum version

2025-12-24 14:27:21 +08:00

9.8 KiB

Raw Blame History

Blowfish

Blowfish ist ein leistungsstarkes, schlankes Theme für Hugo. Es wurde mit Tailwind CSS entwickelt und bietet ein klares, minimalistisches Design, das Ihre Inhalte in den Vordergrund stellt.

🌏 Demo-Website 📑 Theme-Dokumentation 💎 Merchandise-Shop 🐛 Fehlerberichte & Issues 💡 Fragen & Feature-Anfragen

Funktionen

Vollständig responsives Layout mit Tailwind CSS 3.0
Mehrere Farbschemata (oder vollständig anpassbar)
Dark Mode (erzwungen ein/aus oder automatisch mit Benutzerumschaltung)
Hochgradig anpassbare Konfiguration
Firebase-Integration zur Unterstützung dynamischer Daten
Ansichtszähler & Like-Mechanismus
Verwandte Artikel
Mehrere Homepage-Layouts
Mehrere Autoren
Artikelserien
Datums- und gewichtsbasierte Artikelsortierung
Zen-Modus zum Lesen von Artikeln
Flexibel mit beliebigen Inhaltstypen, Taxonomien und Menüs
Kopf- und Fußzeilenmenüs
Verschachtelte Menüs & Unternavigationsmenüs
Scrollbares Inhaltsverzeichnis
Mehrsprachige Inhaltsunterstützung einschließlich RTL-Sprachen
Möglichkeit, auf Beiträge auf Websites von Drittanbietern zu verlinken
Unterstützung für mehrere Shortcodes wie Gallery, Timeline, GitHub-Karten und Carousels
GitHub Alerts-Syntax, 15 Typen, zusammenklappbar
Buymeacoffee-Integration
Clientseitige Website-Suche mit Fuse.js
Diagramme und Visualisierungen mit Mermaid
Charts mit Chart.js
TypeIt-Integration
Youtube-Einbettungen mit Leistungsverbesserungen
Mathematische Notation mit KaTeX
SVG-Icons von FontAwesome 6
Automatische Bildgrößenanpassung mit Hugo Pipes
Überschriften-Anker, Inhaltsverzeichnisse, Code-Kopieren, Buttons, Badges und mehr
HTML- und Emoji-Unterstützung in Artikeln 🎉
SEO-freundlich mit Links zum Teilen in sozialen Medien
Unterstützung für Fathom Analytics und Google Analytics
RSS-Feeds, Favicons und Kommentare
Erweiterte Anpassung mit einfachen Tailwind-Farbdefinitionen und -Stilen
Optimiert für Leistung und Barrierefreiheit mit perfekten Lighthouse-Scores
Vollständig dokumentiert mit regelmäßigen Updates

Dokumentation

Blowfish verfügt über eine umfangreiche Dokumentation, die alle Aspekte des Themes abdeckt. Lesen Sie unbedingt die Dokumentation, um mehr über die Verwendung des Themes und seiner Funktionen zu erfahren.

Installation

Blowfish unterstützt mehrere Installationsmethoden - als git submodule, als Hugo Module oder als vollständig manuelle Installation.

Detaillierte Anweisungen für jede Methode finden Sie in der Installations-Dokumentation. Für die einfachste Einrichtung sollten Sie die Dokumentation konsultieren. Im Folgenden finden Sie eine Schnellstartanleitung mit Submodulen, wenn Sie git verwenden, oder Hugo Modules, wenn Sie bereits Erfahrung mit der Installation von Hugo-Themes haben.

Schnellstart mit Blowfish Tools

Hinweis: Stellen Sie sicher, dass Sie Node.js, Git und Hugo installiert haben und dass Sie ein neues Hugo-Projekt erstellt haben, bevor Sie fortfahren.

Wir haben gerade ein neues CLI-Tool gestartet, das Ihnen beim Einstieg in Blowfish hilft. Es erstellt ein neues Hugo-Projekt, installiert das Theme und richtet die Theme-Konfigurationsdateien für Sie ein. Es befindet sich noch in der Beta-Phase, also melden Sie bitte alle Probleme, die Sie finden.

Installieren Sie das CLI-Tool global mit npm (oder einem anderen Paketmanager):

npm i -g blowfish-tools

Führen Sie dann den Befehl blowfish-tools aus, um eine interaktive Sitzung zu starten, die Sie durch Erstellungs- und Konfigurationsanwendungsfälle führt.

blowfish-tools

Sie können auch den Befehl blowfish-tools new ausführen, um ein neues Hugo-Projekt zu erstellen und das Theme in einem Schritt zu installieren. Weitere Informationen finden Sie in der CLI-Hilfe.

blowfish-tools new mynewsite

Schnellstart mit git submodules

Hinweis: Stellen Sie sicher, dass Sie Git und Hugo installiert haben und dass Sie ein neues Hugo-Projekt erstellt haben, bevor Sie fortfahren.

Initialisieren Sie git aus Ihrem Projektverzeichnis:
```
git init
```

Konfigurieren Sie Blowfish als git submodule:

git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish

Löschen Sie im Stammordner Ihrer Website die von Hugo generierte Datei hugo.toml. Kopieren Sie die *.toml Konfigurationsdateien aus dem Theme in Ihren config/_default/ Ordner.

Sie finden diese Theme-Konfigurationsdateien im Hugo-Cache-Verzeichnis oder laden Sie eine Kopie von GitHub herunter.
Folgen Sie den Anweisungen unter Erste Schritte, um Ihre Website zu konfigurieren.

Schnellstart mit Hugo

Hinweis: Stellen Sie sicher, dass Sie Go und Hugo installiert haben und dass Sie ein neues Hugo-Projekt erstellt haben, bevor Sie fortfahren.

Initialisieren Sie Hugo Modules aus Ihrem Projektverzeichnis:
```
hugo mod init github.com/<username>/<repo-name>
```
Erstellen Sie config/_default/module.toml und fügen Sie Folgendes hinzu:
```
[[imports]]
path = "github.com/nunocoracao/blowfish/v2"
```
Starten Sie Ihren Server mit hugo server und das Theme wird automatisch heruntergeladen.
Löschen Sie im Stammordner Ihrer Website die von Hugo generierte Datei hugo.toml. Kopieren Sie die *.toml Konfigurationsdateien aus dem Theme in Ihren config/_default/ Ordner.

Hinweis: Überschreiben Sie nicht die oben erstellte Datei module.toml!

Sie finden diese Theme-Konfigurationsdateien im Hugo-Cache-Verzeichnis oder laden Sie eine Kopie von GitHub herunter.
Folgen Sie den Anweisungen unter Erste Schritte, um Ihre Website zu konfigurieren.

Theme-Updates installieren

Wenn neue Versionen veröffentlicht werden, können Sie das Theme mit Hugo aktualisieren. Führen Sie einfach hugo mod get -u aus Ihrem Projektverzeichnis aus und das Theme wird automatisch auf die neueste Version aktualisiert.

Detaillierte Update-Anweisungen sind in der Dokumentation verfügbar.

Mitwirken

Blowfish wird sich voraussichtlich im Laufe der Zeit weiterentwickeln. Ich beabsichtige, weiterhin Funktionen hinzuzufügen und nach Bedarf Änderungen vorzunehmen.

Melden Sie sich gerne mit Problemen oder Vorschlägen für neue Funktionen, die Sie gerne sehen würden.

🐛 Fehlerberichte & Issues: Verwenden Sie GitHub Issues
💡 Ideen für neue Funktionen: Eröffnen Sie eine Diskussion auf GitHub Discussions
🙋‍♀️ Allgemeine Fragen: Gehen Sie zu GitHub Discussions

Wenn Sie in der Lage sind, einen Fehler zu beheben oder eine neue Funktion zu implementieren, sind Pull Requests zu diesem Zweck willkommen. Erfahren Sie mehr in den Richtlinien für Mitwirkende.

Stargazers im Zeitverlauf

Mastodon

9.8 KiB Raw Blame History