diff --git a/README.de.md b/README.de.md new file mode 100644 index 00000000..f6763bfd --- /dev/null +++ b/README.de.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | Deutsch | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) +# Blowfish +[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/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. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [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) + + + +Buy Me A Coffee + + + + +## 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 + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## 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// + ``` + +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 + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.es.md b/README.es.md new file mode 100644 index 00000000..0c73ed3b --- /dev/null +++ b/README.es.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | Español | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) +# Blowfish +[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/blowfish) + +Blowfish está diseñado para ser un tema potente y ligero para [Hugo](https://gohugo.io). Está construido usando Tailwind CSS con un diseño limpio y minimalista que prioriza tu contenido. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [Sitio de demostración](https://blowfish.page/) +📑 [Documentación del tema](https://blowfish.page/docs/) +💎 [Tienda de merchandising](http://tee.pub/lic/qwSlWVBL5zc) +🐛 [Reportes de errores y problemas](https://github.com/nunocoracao/blowfish/issues) +💡 [Preguntas y solicitudes de funcionalidades](https://github.com/nunocoracao/blowfish/discussions) + + + +Buy Me A Coffee + + + + +## Características + +- Diseño totalmente responsive construido con Tailwind CSS 3.0 +- Múltiples esquemas de color (o personaliza completamente el tuyo propio) +- Modo oscuro (forzado activado/desactivado o cambio automático con opción de usuario) +- Configuración altamente personalizable +- Integración con Firebase para soportar datos dinámicos +- Contador de vistas y mecanismo de likes +- Artículos relacionados +- Múltiples diseños de página de inicio +- Múltiples autores +- Series de artículos +- Ordenación de artículos basada en fecha y peso +- Modo zen para lectura de artículos +- Flexible con cualquier tipo de contenido, taxonomías y menús +- Menús de encabezado y pie de página +- Menús anidados y menú de sub-navegación +- Tabla de contenidos con desplazamiento +- Soporte de contenido multilingüe incluyendo idiomas RTL +- Capacidad de enlazar a publicaciones en sitios web de terceros +- Soporte para varios shortcodes como Gallery, Timeline, GitHub cards y Carousels +- Sintaxis de GitHub Alerts, 15 tipos, soporte plegable +- Integración con Buymeacoffee +- Búsqueda en el sitio del lado del cliente impulsada por Fuse.js +- Diagramas y visualizaciones usando Mermaid +- Gráficos usando Chart.js +- Integración con TypeIt +- Incrustaciones de Youtube con mejoras de rendimiento +- Notación matemática usando KaTeX +- Iconos SVG de FontAwesome 6 +- Redimensionamiento automático de imágenes usando Hugo Pipes +- Anclajes de encabezados, Tablas de contenidos, Copia de código, Botones, Insignias y más +- Soporte de HTML y Emoji en artículos 🎉 +- SEO amigable con enlaces para compartir en redes sociales +- Soporte para Fathom Analytics y Google Analytics +- Feeds RSS, Favicons y soporte de comentarios +- Personalización avanzada usando definiciones de colores y estilos simples de Tailwind +- Optimizado para rendimiento y accesibilidad con puntuaciones perfectas en Lighthouse +- Completamente documentado con actualizaciones regulares + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## Documentación + +Blowfish tiene [documentación extensa](https://blowfish.page/docs/) que cubre todos los aspectos del tema. Asegúrate de [leer la documentación](https://blowfish.page/docs/) para aprender más sobre cómo usar el tema y sus características. + +--- + +## Instalación + +Blowfish soporta varios métodos de instalación - como submódulo de git, módulo de Hugo, o como una instalación completamente manual. + +Las instrucciones detalladas para cada método se pueden encontrar en la documentación de [Instalación](https://blowfish.page/docs/installation). Deberías consultar la documentación para obtener la experiencia de configuración más simple. A continuación se presenta una guía de inicio rápido usando submódulos si estás usando git, o módulos de Hugo si ya tienes confianza instalando temas de Hugo. + +### Inicio rápido usando Blowfish Tools + +> **Nota:** Asegúrate de tener **Node.js**, **Git** y **Hugo** instalados, y de haber creado un nuevo proyecto Hugo antes de continuar. + +Acabamos de lanzar una nueva herramienta CLI para ayudarte a comenzar con Blowfish. Creará un nuevo proyecto Hugo, instalará el tema y configurará los archivos de configuración del tema por ti. Todavía está en beta, así que por favor [reporta cualquier problema que encuentres](https://github.com/nunocoracao/blowfish-tools). + +Instala la herramienta CLI globalmente usando npm (u otro gestor de paquetes): +```shell +npm i -g blowfish-tools +``` + +Luego ejecuta el comando `blowfish-tools` para iniciar una ejecución interactiva que te guiará a través de los casos de uso de creación y configuración. +```shell +blowfish-tools +``` + +También puedes ejecutar el comando `blowfish-tools new` para crear un nuevo proyecto Hugo e instalar el tema de una sola vez. Consulta la ayuda de CLI para más información. +```shell +blowfish-tools new mynewsite +``` + +### Inicio rápido usando submódulos de git + +> **Nota:** Asegúrate de tener **Git** y **Hugo** instalados, y de haber creado un nuevo proyecto Hugo antes de continuar. + +1. Desde el directorio de tu proyecto, inicializa git: + + ```shell + git init + ``` + +2. Configura Blowfish como un submódulo de git: + + ```shell + git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish + ``` + +3. En la carpeta raíz de tu sitio web, elimina el archivo `hugo.toml` que fue generado por Hugo. Copia los archivos de configuración `*.toml` del tema en tu carpeta `config/_default/`. + + Encontrarás estos archivos de configuración del tema en el directorio de caché de Hugo, o [descarga una copia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) desde GitHub. + +4. Sigue las instrucciones de [Primeros Pasos](https://blowfish.page/docs/getting-started/) para configurar tu sitio web. + +### Inicio rápido usando Hugo + +> **Nota:** Asegúrate de tener **Go** y **Hugo** instalados, y de haber creado un nuevo proyecto Hugo antes de continuar. + +1. Desde el directorio de tu proyecto, inicializa los Módulos de Hugo: + + ```shell + hugo mod init github.com// + ``` + +2. Crea `config/_default/module.toml` y agrega lo siguiente: + + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v2" + ``` + +3. Inicia tu servidor usando `hugo server` y el tema se descargará automáticamente. + +4. En la carpeta raíz de tu sitio web, elimina el archivo `hugo.toml` que fue generado por Hugo. Copia los archivos de configuración `*.toml` del tema en tu carpeta `config/_default/`. + + > **Nota:** ¡No sobrescribas el archivo `module.toml` que creaste arriba! + + Encontrarás estos archivos de configuración del tema en el directorio de caché de Hugo, o [descarga una copia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) desde GitHub. + +5. Sigue las instrucciones de [Primeros Pasos](https://blowfish.page/docs/getting-started/) para configurar tu sitio web. + +### Instalación de actualizaciones del tema + +A medida que se publiquen nuevas versiones, puedes actualizar el tema usando Hugo. Simplemente ejecuta `hugo mod get -u` desde el directorio de tu proyecto y el tema se actualizará automáticamente a la última versión. + +Las [instrucciones de actualización](https://blowfish.page/docs/installation/#installing-updates) detalladas están disponibles en la documentación. + +--- + +## Contribuciones + +Se espera que Blowfish evolucione con el tiempo. Tengo la intención de seguir agregando características y haciendo cambios según sea necesario. + +Siéntete libre de ponerte en contacto con cualquier problema o sugerencia de nuevas características que te gustaría ver. + +- 🐛 **Reportes de errores y problemas:** Usa [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) +- 💡 **Ideas para nuevas características:** Abre una discusión en [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) +- 🙋‍♀️ **Preguntas generales:** Dirígete a [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + +Si puedes corregir un error o implementar una nueva característica, acepto PRs para este propósito. Aprende más en las [guías de contribución](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md). + +--- + +## Stargazers a lo largo del tiempo + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.fr.md b/README.fr.md new file mode 100644 index 00000000..c2ac55c2 --- /dev/null +++ b/README.fr.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | Français | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) +# Blowfish +[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/blowfish) + +Blowfish est conçu pour être un thème puissant et léger pour [Hugo](https://gohugo.io). Il est construit avec Tailwind CSS avec un design épuré et minimaliste qui donne la priorité à votre contenu. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [Site de démonstration](https://blowfish.page/) +📑 [Documentation du thème](https://blowfish.page/docs/) +💎 [Boutique de produits dérivés](http://tee.pub/lic/qwSlWVBL5zc) +🐛 [Rapports de bugs et problèmes](https://github.com/nunocoracao/blowfish/issues) +💡 [Questions et demandes de fonctionnalités](https://github.com/nunocoracao/blowfish/discussions) + + + +Buy Me A Coffee + + + + +## Fonctionnalités + +- Disposition entièrement responsive construite avec Tailwind CSS 3.0 +- Plusieurs palettes de couleurs (ou personnalisez entièrement la vôtre) +- Mode sombre (forcé activé/désactivé ou basculement automatique avec commutateur utilisateur) +- Configuration hautement personnalisable +- Intégration Firebase pour prendre en charge les données dynamiques +- Compteur de vues et mécanisme de likes +- Articles connexes +- Plusieurs mises en page pour la page d'accueil +- Plusieurs auteurs +- Séries d'articles +- Tri des articles basé sur la date et le poids +- Mode Zen pour la lecture d'articles +- Flexible avec tous les types de contenu, taxonomies et menus +- Menus d'en-tête et de pied de page +- Menus imbriqués et menu de sous-navigation +- Table des matières défilable +- Support du contenu multilingue incluant la prise en charge des langues RTL +- Possibilité de lier des articles sur des sites web tiers +- Prise en charge de plusieurs shortcodes comme Gallery, Timeline, GitHub cards et Carousels +- Syntaxe GitHub Alerts, 15 types, support pliable +- Intégration Buymeacoffee +- Recherche côté client alimentée par Fuse.js +- Diagrammes et visualisations utilisant Mermaid +- Graphiques utilisant Chart.js +- Intégration TypeIt +- Intégrations Youtube avec améliorations de performance +- Notation mathématique utilisant KaTeX +- Icônes SVG de FontAwesome 6 +- Redimensionnement automatique des images utilisant Hugo Pipes +- Ancres de titres, Tables des matières, Copie de code, Boutons, Badges et plus +- Support HTML et Emoji dans les articles 🎉 +- SEO optimisé avec liens pour partage sur les réseaux sociaux +- Support de Fathom Analytics et Google Analytics +- Flux RSS, Favicons et support des commentaires +- Personnalisation avancée utilisant de simples définitions de couleurs et styles Tailwind +- Optimisé pour les performances et l'accessibilité avec des scores Lighthouse parfaits +- Entièrement documenté avec des mises à jour régulières + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## Documentation + +Blowfish dispose d'une [documentation complète](https://blowfish.page/docs/) qui couvre tous les aspects du thème. Assurez-vous de [lire la documentation](https://blowfish.page/docs/) pour en savoir plus sur l'utilisation du thème et de ses fonctionnalités. + +--- + +## Installation + +Blowfish prend en charge plusieurs méthodes d'installation - en tant que sous-module git, module Hugo, ou en tant qu'installation complètement manuelle. + +Des instructions détaillées pour chaque méthode se trouvent dans la documentation [Installation](https://blowfish.page/docs/installation). Vous devriez consulter la documentation pour l'expérience de configuration la plus simple. Ci-dessous se trouve un guide de démarrage rapide utilisant les sous-modules si vous utilisez git, ou les modules Hugo si vous êtes déjà à l'aise avec l'installation de thèmes Hugo. + +### Démarrage rapide avec Blowfish Tools + +> **Note :** Assurez-vous d'avoir **Node.js**, **Git** et **Hugo** installés, et d'avoir créé un nouveau projet Hugo avant de continuer. + +Nous venons de lancer un nouvel outil CLI pour vous aider à démarrer avec Blowfish. Il créera un nouveau projet Hugo, installera le thème et configurera les fichiers de configuration du thème pour vous. Il est encore en version bêta, veuillez donc [signaler tout problème que vous rencontrez](https://github.com/nunocoracao/blowfish-tools). + +Installez l'outil CLI globalement en utilisant npm (ou un autre gestionnaire de paquets) : +```shell +npm i -g blowfish-tools +``` + +Ensuite, exécutez la commande `blowfish-tools` pour démarrer une exécution interactive qui vous guidera à travers les cas d'utilisation de création et de configuration. +```shell +blowfish-tools +``` + +Vous pouvez également exécuter la commande `blowfish-tools new` pour créer un nouveau projet Hugo et installer le thème en une seule fois. Consultez l'aide du CLI pour plus d'informations. +```shell +blowfish-tools new mynewsite +``` + +### Démarrage rapide avec les sous-modules git + +> **Note :** Assurez-vous d'avoir **Git** et **Hugo** installés, et d'avoir créé un nouveau projet Hugo avant de continuer. + +1. Depuis le répertoire de votre projet, initialisez git : + + ```shell + git init + ``` + +2. Configurez Blowfish comme un sous-module git : + + ```shell + git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish + ``` + +3. Dans le dossier racine de votre site web, supprimez le fichier `hugo.toml` qui a été généré par Hugo. Copiez les fichiers de configuration `*.toml` du thème dans votre dossier `config/_default/`. + + Vous trouverez ces fichiers de configuration du thème dans le répertoire cache de Hugo, ou [téléchargez une copie](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) depuis GitHub. + +4. Suivez les instructions [Pour commencer](https://blowfish.page/docs/getting-started/) pour configurer votre site web. + +### Démarrage rapide avec Hugo + +> **Note :** Assurez-vous d'avoir **Go** et **Hugo** installés, et d'avoir créé un nouveau projet Hugo avant de continuer. + +1. Depuis le répertoire de votre projet, initialisez les modules Hugo : + + ```shell + hugo mod init github.com// + ``` + +2. Créez `config/_default/module.toml` et ajoutez ce qui suit : + + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v2" + ``` + +3. Démarrez votre serveur en utilisant `hugo server` et le thème sera téléchargé automatiquement. + +4. Dans le dossier racine de votre site web, supprimez le fichier `hugo.toml` qui a été généré par Hugo. Copiez les fichiers de configuration `*.toml` du thème dans votre dossier `config/_default/`. + + > **Note :** Ne remplacez pas le fichier `module.toml` que vous avez créé ci-dessus ! + + Vous trouverez ces fichiers de configuration du thème dans le répertoire cache de Hugo, ou [téléchargez une copie](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) depuis GitHub. + +5. Suivez les instructions [Pour commencer](https://blowfish.page/docs/getting-started/) pour configurer votre site web. + +### Installation des mises à jour du thème + +Au fur et à mesure que de nouvelles versions sont publiées, vous pouvez mettre à jour le thème en utilisant Hugo. Exécutez simplement `hugo mod get -u` depuis le répertoire de votre projet et le thème se mettra automatiquement à jour vers la dernière version. + +Des [instructions de mise à jour](https://blowfish.page/docs/installation/#installing-updates) détaillées sont disponibles dans la documentation. + +--- + +## Contribuer + +Blowfish est destiné à évoluer au fil du temps. J'ai l'intention de continuer à ajouter des fonctionnalités et à apporter des modifications selon les besoins. + +N'hésitez pas à me contacter pour tout problème ou suggestion de nouvelles fonctionnalités que vous aimeriez voir. + +- 🐛 **Rapports de bugs et problèmes :** Utilisez [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) +- 💡 **Idées de nouvelles fonctionnalités :** Ouvrez une discussion sur [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) +- 🙋‍♀️ **Questions générales :** Rendez-vous sur [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + +Si vous êtes en mesure de corriger un bug ou de mettre en œuvre une nouvelle fonctionnalité, j'accueille les PR à cette fin. Apprenez-en plus dans les [directives de contribution](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md). + +--- + +## Évolution des stargazers + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.ja.md b/README.ja.md index ccce3140..e199902a 100644 --- a/README.ja.md +++ b/README.ja.md @@ -1,4 +1,4 @@ -[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [Indonesian](https://github.com/nunocoracao/blowfish/blob/main/README.id.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | 日本語 +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | 日本語 | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) # Blowfish [![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) [![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) diff --git a/README.md b/README.md index 10791da9..95369b95 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -English | [Indonesian](https://github.com/nunocoracao/blowfish/blob/main/README.id.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) +English | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) # Blowfish [![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) [![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) diff --git a/README.pt-br.md b/README.pt-br.md new file mode 100644 index 00000000..a06f6183 --- /dev/null +++ b/README.pt-br.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | Português (BR) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) +# Blowfish +[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/blowfish) + +Blowfish foi projetado para ser um tema poderoso e leve para [Hugo](https://gohugo.io). É construído usando Tailwind CSS com um design limpo e minimalista que prioriza o seu conteúdo. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [Site de demonstração](https://blowfish.page/) +📑 [Documentação do tema](https://blowfish.page/docs/) +💎 [Loja de produtos](http://tee.pub/lic/qwSlWVBL5zc) +🐛 [Relatórios de bugs e problemas](https://github.com/nunocoracao/blowfish/issues) +💡 [Perguntas e solicitações de recursos](https://github.com/nunocoracao/blowfish/discussions) + + + +Buy Me A Coffee + + + + +## Recursos + +- Layout totalmente responsivo construído com Tailwind CSS 3.0 +- Múltiplos esquemas de cores (ou personalize completamente o seu próprio) +- Modo escuro (forçado ligado/desligado ou alternância automática com botão do usuário) +- Configuração altamente personalizável +- Integração com Firebase para suportar dados dinâmicos +- Contagem de visualizações e mecanismo de curtidas +- Artigos relacionados +- Múltiplos layouts de página inicial +- Múltiplos autores +- Séries de artigos +- Ordenação de artigos baseada em data e peso +- Modo zen para leitura de artigos +- Flexível com qualquer tipo de conteúdo, taxonomias e menus +- Menus de cabeçalho e rodapé +- Menus aninhados e menu de sub-navegação +- Índice com rolagem +- Suporte a conteúdo multilíngue incluindo suporte para idiomas RTL +- Capacidade de linkar para posts em sites de terceiros +- Suporte para vários shortcodes como Gallery, Timeline, GitHub cards e Carousels +- Sintaxe de alertas do GitHub, 15 tipos, suporte recolhível +- Integração com Buymeacoffee +- Busca no site do lado do cliente alimentada por Fuse.js +- Diagramas e visualizações usando Mermaid +- Gráficos usando Chart.js +- Integração com TypeIt +- Embeds do Youtube com melhorias de performance +- Notação matemática usando KaTeX +- Ícones SVG do FontAwesome 6 +- Redimensionamento automático de imagens usando Hugo Pipes +- Âncoras de cabeçalho, Índices, Cópia de código, Botões, Badges e mais +- Suporte a HTML e Emoji em artigos 🎉 +- SEO amigável com links para compartilhamento em redes sociais +- Suporte a Fathom Analytics e Google Analytics +- Suporte a feeds RSS, Favicons e comentários +- Personalização avançada usando definições simples de cores e estilos do Tailwind +- Otimizado para performance e acessibilidade com pontuações perfeitas no Lighthouse +- Totalmente documentado com atualizações regulares + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## Documentação + +Blowfish possui [documentação extensa](https://blowfish.page/docs/) que cobre todos os aspectos do tema. Certifique-se de [ler a documentação](https://blowfish.page/docs/) para saber mais sobre como usar o tema e seus recursos. + +--- + +## Instalação + +Blowfish suporta vários métodos de instalação - como submódulo git, Hugo Module, ou como uma instalação completamente manual. + +Instruções detalhadas para cada método podem ser encontradas na documentação de [Instalação](https://blowfish.page/docs/installation). Você deve consultar a documentação para a experiência de configuração mais simples. Abaixo está um guia de início rápido usando submódulos se você estiver usando git, ou Hugo modules se você já estiver confiante em instalar temas Hugo. + +### Início rápido usando Blowfish Tools + +> **Nota:** Certifique-se de ter **Node.js**, **Git** e **Hugo** instalados, e que você criou um novo projeto Hugo antes de prosseguir. + +Acabamos de lançar uma nova ferramenta CLI para ajudá-lo a começar com Blowfish. Ela criará um novo projeto Hugo, instalará o tema e configurará os arquivos de configuração do tema para você. Ainda está em beta, então por favor [reporte quaisquer problemas que encontrar](https://github.com/nunocoracao/blowfish-tools). + +Instale a ferramenta CLI globalmente usando npm (ou outro gerenciador de pacotes): +```shell +npm i -g blowfish-tools +``` + +Em seguida, execute o comando `blowfish-tools` para iniciar uma execução interativa que o guiará pelos casos de uso de criação e configuração. +```shell +blowfish-tools +``` + +Você também pode executar o comando `blowfish-tools new` para criar um novo projeto Hugo e instalar o tema de uma vez. Verifique a ajuda da CLI para mais informações. +```shell +blowfish-tools new mynewsite +``` + +### Início rápido usando submódulos git + +> **Nota:** Certifique-se de ter **Git** e **Hugo** instalados, e que você criou um novo projeto Hugo antes de prosseguir. + +1. Do diretório do seu projeto, inicialize o git: + + ```shell + git init + ``` + +2. Configure Blowfish como um submódulo git: + + ```shell + git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish + ``` + +3. Na pasta raiz do seu site, exclua o arquivo `hugo.toml` que foi gerado pelo Hugo. Copie os arquivos de configuração `*.toml` do tema para sua pasta `config/_default/`. + + Você encontrará esses arquivos de configuração do tema no diretório de cache do Hugo, ou [baixe uma cópia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) do GitHub. + +4. Siga as instruções de [Primeiros Passos](https://blowfish.page/docs/getting-started/) para configurar seu site. + +### Início rápido usando Hugo + +> **Nota:** Certifique-se de ter **Go** e **Hugo** instalados, e que você criou um novo projeto Hugo antes de prosseguir. + +1. Do diretório do seu projeto, inicialize os Hugo Modules: + + ```shell + hugo mod init github.com// + ``` + +2. Crie `config/_default/module.toml` e adicione o seguinte: + + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v2" + ``` + +3. Inicie seu servidor usando `hugo server` e o tema será baixado automaticamente. + +4. Na pasta raiz do seu site, exclua o arquivo `hugo.toml` que foi gerado pelo Hugo. Copie os arquivos de configuração `*.toml` do tema para sua pasta `config/_default/`. + + > **Nota:** Não sobrescreva o arquivo `module.toml` que você criou acima! + + Você encontrará esses arquivos de configuração do tema no diretório de cache do Hugo, ou [baixe uma cópia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) do GitHub. + +5. Siga as instruções de [Primeiros Passos](https://blowfish.page/docs/getting-started/) para configurar seu site. + +### Instalando atualizações do tema + +À medida que novos lançamentos são publicados, você pode atualizar o tema usando Hugo. Simplesmente execute `hugo mod get -u` do diretório do seu projeto e o tema será atualizado automaticamente para a versão mais recente. + +[Instruções detalhadas de atualização](https://blowfish.page/docs/installation/#installing-updates) estão disponíveis na documentação. + +--- + +## Contribuindo + +Blowfish deve evoluir ao longo do tempo. Pretendo continuar adicionando recursos e fazendo alterações conforme necessário. + +Sinta-se à vontade para entrar em contato com quaisquer problemas ou sugestões de novos recursos que você gostaria de ver. + +- 🐛 **Relatórios de bugs e problemas:** Use [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) +- 💡 **Ideias para novos recursos:** Abra uma discussão em [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) +- 🙋‍♀️ **Perguntas gerais:** Vá para [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + +Se você for capaz de corrigir um bug ou implementar um novo recurso, dou as boas-vindas a PRs para este propósito. Saiba mais nas [diretrizes de contribuição](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md). + +--- + +## Stargazers ao longo do tempo + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.pt-pt.md b/README.pt-pt.md new file mode 100644 index 00000000..0d71c490 --- /dev/null +++ b/README.pt-pt.md @@ -0,0 +1,179 @@ +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | [简体中文](https://github.com/nunocoracao/blowfish/blob/main/README.zh-cn.md) | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | Português (PT) +# Blowfish +[![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) +[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0) +[![GitHub](https://img.shields.io/github/license/nunocoracao/blowfish)](https://github.com/nunocoracao/blowfish/blob/main/LICENSE) +[![Blowfish](https://img.shields.io/badge/Hugo--Themes-@Blowfish-blue)](https://themes.gohugo.io/themes/blowfish/) +![code-size](https://img.shields.io/github/languages/code-size/nunocoracao/blowfish) + +Blowfish foi desenhado para ser um tema poderoso e leve para [Hugo](https://gohugo.io). É construído com Tailwind CSS com um design limpo e minimalista que prioriza o seu conteúdo. + +![blowfish screenshot](https://github.com/nunocoracao/blowfish/blob/main/images/screenshot.png?raw=true) + + +🌏 [Site de demonstração](https://blowfish.page/) +📑 [Documentação do tema](https://blowfish.page/docs/) +💎 [Loja de merchandising](http://tee.pub/lic/qwSlWVBL5zc) +🐛 [Relatórios de erros & problemas](https://github.com/nunocoracao/blowfish/issues) +💡 [Questões & pedidos de funcionalidades](https://github.com/nunocoracao/blowfish/discussions) + + + +Buy Me A Coffee + + + + +## Funcionalidades + +- Layout totalmente responsivo construído com Tailwind CSS 3.0 +- Múltiplos esquemas de cores (ou personalize completamente o seu próprio) +- Modo escuro (forçado ligado/desligado ou alternância automática com seletor do utilizador) +- Configuração altamente personalizável +- Integração com Firebase para suportar dados dinâmicos +- Contagem de visualizações & mecanismo de gostos +- Artigos relacionados +- Múltiplos layouts de página inicial +- Múltiplos autores +- Séries de artigos +- Ordenação de artigos baseada em data e peso +- Modo Zen para leitura de artigos +- Flexível com qualquer tipo de conteúdo, taxonomias e menus +- Menus de cabeçalho e rodapé +- Menus aninhados & menu de sub-navegação +- Índice de conteúdos com scroll +- Suporte para conteúdo multilingue incluindo suporte para línguas RTL +- Capacidade de criar links para publicações em sites de terceiros +- Suporte para vários shortcodes como Gallery, Timeline, GitHub cards e Carousels +- Sintaxe GitHub Alerts, 15 tipos, suporte para elementos expansíveis +- Integração Buymeacoffee +- Pesquisa no site do lado do cliente alimentada por Fuse.js +- Diagramas e visualizações usando Mermaid +- Gráficos usando Chart.js +- Integração TypeIt +- Embeds de Youtube com melhorias de desempenho +- Notação matemática usando KaTeX +- Ícones SVG do FontAwesome 6 +- Redimensionamento automático de imagens usando Hugo Pipes +- Âncoras de cabeçalhos, Índices de Conteúdos, Cópia de código, Botões, Badges e mais +- Suporte HTML e Emoji em artigos 🎉 +- Otimizado para SEO com links para partilha em redes sociais +- Suporte para Fathom Analytics e Google Analytics +- Feeds RSS, Favicons e suporte para comentários +- Personalização avançada usando definições simples de cores e estilos do Tailwind +- Otimizado para desempenho e acessibilidade com pontuações perfeitas no Lighthouse +- Totalmente documentado com atualizações regulares + +--- + +![blowfish logo](https://github.com/nunocoracao/blowfish/blob/main/logo.png?raw=true) + +## Documentação + +Blowfish tem [documentação extensa](https://blowfish.page/docs/) que cobre todos os aspetos do tema. Certifique-se de [ler a documentação](https://blowfish.page/docs/) para saber mais sobre como usar o tema e as suas funcionalidades. + +--- + +## Instalação + +Blowfish suporta vários métodos de instalação - como um submódulo git, um Módulo Hugo, ou como uma instalação completamente manual. + +Instruções detalhadas para cada método podem ser encontradas na documentação de [Instalação](https://blowfish.page/docs/installation). Deve consultar a documentação para a experiência de configuração mais simples. Abaixo está um guia de início rápido usando submódulos se estiver a usar git, ou módulos Hugo se já está confiante na instalação de temas Hugo. + +### Início rápido usando Blowfish Tools + +> **Nota:** Certifique-se de que tem **Node.js**, **Git** e **Hugo** instalados, e que criou um novo projeto Hugo antes de continuar. + +Acabámos de lançar uma nova ferramenta CLI para ajudá-lo a começar com Blowfish. Ela irá criar um novo projeto Hugo, instalar o tema e configurar os ficheiros de configuração do tema para si. Ainda está em beta por isso [reporte quaisquer problemas que encontrar](https://github.com/nunocoracao/blowfish-tools). + +Instale a ferramenta CLI globalmente usando npm (ou outro gestor de pacotes): +```shell +npm i -g blowfish-tools +``` + +Depois execute o comando `blowfish-tools` para iniciar uma execução interativa que irá guiá-lo através da criação e casos de uso de configuração. +```shell +blowfish-tools +``` + +Também pode executar o comando `blowfish-tools new` para criar um novo projeto Hugo e instalar o tema de uma só vez. Consulte a ajuda da CLI para mais informações. +```shell +blowfish-tools new mynewsite +``` + +### Início rápido usando submódulos git + +> **Nota:** Certifique-se de que tem **Git** e **Hugo** instalados, e que criou um novo projeto Hugo antes de continuar. + +1. A partir do diretório do seu projeto, inicialize o git: + + ```shell + git init + ``` + +2. Configure Blowfish como um submódulo git: + + ```shell + git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish + ``` + +3. Na pasta raiz do seu site, elimine o ficheiro `hugo.toml` que foi gerado pelo Hugo. Copie os ficheiros de configuração `*.toml` do tema para a sua pasta `config/_default/`. + + Irá encontrar estes ficheiros de configuração do tema no diretório de cache do Hugo, ou [descarregue uma cópia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) do GitHub. + +4. Siga as instruções de [Introdução](https://blowfish.page/docs/getting-started/) para configurar o seu site. + +### Início rápido usando Hugo + +> **Nota:** Certifique-se de que tem **Go** e **Hugo** instalados, e que criou um novo projeto Hugo antes de continuar. + +1. A partir do diretório do seu projeto, inicialize os Módulos Hugo: + + ```shell + hugo mod init github.com// + ``` + +2. Crie `config/_default/module.toml` e adicione o seguinte: + + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v2" + ``` + +3. Inicie o seu servidor usando `hugo server` e o tema será descarregado automaticamente. + +4. Na pasta raiz do seu site, elimine o ficheiro `hugo.toml` que foi gerado pelo Hugo. Copie os ficheiros de configuração `*.toml` do tema para a sua pasta `config/_default/`. + + > **Nota:** Não sobrescreva o ficheiro `module.toml` que criou acima! + + Irá encontrar estes ficheiros de configuração do tema no diretório de cache do Hugo, ou [descarregue uma cópia](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) do GitHub. + +5. Siga as instruções de [Introdução](https://blowfish.page/docs/getting-started/) para configurar o seu site. + +### Instalar atualizações do tema + +À medida que novas versões são publicadas, pode atualizar o tema usando Hugo. Simplesmente execute `hugo mod get -u` a partir do diretório do seu projeto e o tema será automaticamente atualizado para a versão mais recente. + +[Instruções detalhadas de atualização](https://blowfish.page/docs/installation/#installing-updates) estão disponíveis na documentação. + +--- + +## Contribuir + +Espera-se que Blowfish evolua ao longo do tempo. Pretendo continuar a adicionar funcionalidades e fazer alterações conforme necessário. + +Sinta-se à vontade para entrar em contacto com quaisquer problemas ou sugestões para novas funcionalidades que gostaria de ver. + +- 🐛 **Relatórios de erros & problemas:** Use [GitHub Issues](https://github.com/nunocoracao/blowfish/issues) +- 💡 **Ideias para novas funcionalidades:** Abra uma discussão em [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) +- 🙋‍♀️ **Questões gerais:** Dirija-se a [GitHub Discussions](https://github.com/nunocoracao/blowfish/discussions) + +Se conseguir corrigir um erro ou implementar uma nova funcionalidade, aceito PRs para este propósito. Saiba mais nas [diretrizes de contribuição](https://github.com/nunocoracao/blowfish/blob/main/CONTRIBUTING.md). + +--- + +## Stargazers ao longo do tempo + +[![Stargazers over time](https://starchart.cc/nunocoracao/blowfish.svg)](https://starchart.cc/nunocoracao/blowfish) + +Mastodon diff --git a/README.zh-cn.md b/README.zh-cn.md index e4879d97..abcd1ebd 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -1,4 +1,4 @@ -[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [Indonesian](https://github.com/nunocoracao/blowfish/blob/main/README.id.md) | 简体中文 | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) +[English](https://github.com/nunocoracao/blowfish/blob/main/README.md) | [日本語](https://github.com/nunocoracao/blowfish/blob/main/README.ja.md) | 简体中文 | [Deutsch](https://github.com/nunocoracao/blowfish/blob/main/README.de.md) | [Français](https://github.com/nunocoracao/blowfish/blob/main/README.fr.md) | [Español](https://github.com/nunocoracao/blowfish/blob/main/README.es.md) | [Português (BR)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-br.md) | [Português (PT)](https://github.com/nunocoracao/blowfish/blob/main/README.pt-pt.md) # Blowfish [![Netlify Status](https://api.netlify.com/api/v1/badges/6e5256d4-3148-4d69-879c-310341020fe9/deploy-status)](https://app.netlify.com/sites/snazzy-dango-efb2ec/deploys) [![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.87.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.87.0)