mirror of
https://github.com/nunocoracao/blowfish.git
synced 2026-01-30 16:31:52 +01:00
180 lines
9.8 KiB
Markdown
180 lines
9.8 KiB
Markdown
[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | Deutsch | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Indonesian](https://github.com/nunocoracao/blowfish/blob/main/README.id.md)
|
|
# Blowfish
|
|
[](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys)
|
|
[](https://github.com/gohugoio/hugo/releases/tag/v0.141.0)
|
|
[](https://github.com/nunocoracao/blowfish/blob/main/LICENSE)
|
|
[](https://themes.gohugo.io/themes/blowfish/)
|
|
|
|
|
|
Blowfish ist ein leistungsstarkes, schlankes Theme für [Hugo](https://gohugo.io). Es wurde mit Tailwind CSS entwickelt und bietet ein klares, minimalistisches Design, das Ihre Inhalte in den Vordergrund stellt.
|
|
|
|
|
|
|
|
|
|
🌏 [Demo-Website](https://blowfish.page/)
|
|
📑 [Theme-Dokumentation](https://blowfish.page/docs/)
|
|
💎 [Merchandise-Shop](http://tee.pub/lic/qwSlWVBL5zc)
|
|
🐛 [Fehlerberichte & Issues](https://github.com/nunocoracao/blowfish/issues)
|
|
💡 [Fragen & Feature-Anfragen](https://github.com/nunocoracao/blowfish/discussions)
|
|
|
|
|
|
|
|
<a href="https://www.buymeacoffee.com/nunocoracao" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
|
|
<a target="_blank" href="http://tee.pub/lic/qwSlWVBL5zc"><img class="nozoom" src="https://img.buymeacoffee.com/button-api/?text=Merch Store &emoji=💎&slug=nunocoracao&button_colour=5F7FFF&font_colour=ffffff&font_family=Lato&outline_colour=000000&coffee_colour=FFDD00" /></a>
|
|
|
|
|
|
|
|
## 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](https://blowfish.page/docs/), die alle Aspekte des Themes abdeckt. Lesen Sie unbedingt die [Dokumentation](https://blowfish.page/docs/), 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](https://blowfish.page/docs/installation). 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](https://github.com/nunocoracao/blowfish-tools).
|
|
|
|
Installieren Sie das CLI-Tool global mit npm (oder einem anderen Paketmanager):
|
|
```shell
|
|
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.
|
|
```shell
|
|
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.
|
|
```shell
|
|
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.
|
|
|
|
1. Initialisieren Sie git aus Ihrem Projektverzeichnis:
|
|
|
|
```shell
|
|
git init
|
|
```
|
|
|
|
2. Konfigurieren Sie Blowfish als git submodule:
|
|
|
|
```shell
|
|
git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish
|
|
```
|
|
|
|
3. 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](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) von GitHub herunter.
|
|
|
|
4. Folgen Sie den Anweisungen unter [Erste Schritte](https://blowfish.page/docs/getting-started/), 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.
|
|
|
|
1. Initialisieren Sie Hugo Modules aus Ihrem Projektverzeichnis:
|
|
|
|
```shell
|
|
hugo mod init github.com/<username>/<repo-name>
|
|
```
|
|
|
|
2. Erstellen Sie `config/_default/module.toml` und fügen Sie Folgendes hinzu:
|
|
|
|
```toml
|
|
[[imports]]
|
|
path = "github.com/nunocoracao/blowfish/v2"
|
|
```
|
|
|
|
3. Starten Sie Ihren Server mit `hugo server` und das Theme wird automatisch heruntergeladen.
|
|
|
|
4. 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](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) von GitHub herunter.
|
|
|
|
5. Folgen Sie den Anweisungen unter [Erste Schritte](https://blowfish.page/docs/getting-started/), 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](https://blowfish.page/docs/installation/#installing-updates) 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](https://github.com/nunocoracao/blowfish/issues)
|
|
- 💡 **Ideen für neue Funktionen:** Eröffnen Sie eine Diskussion auf [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions)
|
|
- 🙋♀️ **Allgemeine Fragen:** Gehen Sie zu [GitHub Discussions](https://github.com/nunocoracao/blowfish/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](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md).
|
|
|
|
---
|
|
|
|
## Stargazers im Zeitverlauf
|
|
|
|
[](https://starchart.cc/nunocoracao/blowfish)
|
|
|
|
<a rel="me" href="https://masto.ai/@blowfish">Mastodon</a>
|