diff --git a/README.id.md b/README.id.md index b055c247..8f683d46 100644 --- a/README.id.md +++ b/README.id.md @@ -22,14 +22,20 @@ Blowfish dirancang sebagai tema yang kuat dan ringan untuk [Hugo](https://gohugo ## Fitur -- Tata letak responsif sepenuhnya dengan Tailwind CSS 3.0 +- Tata letak responsif sepenuhnya dengan Tailwind CSS 4 - Beragam skema warna (atau sesuaikan sendiri) - Mode gelap (paksa aktif/nonaktif atau otomatis dengan pengaturan pengguna) +- Beragam tata letak halaman utama, termasuk landing page bergaya produk dengan gambar hero, statistik, dan grid fitur +- Header kaca mengambang dengan pintasan pencarian ⌘K / Ctrl+K +- Kanvas latar belakang global dengan bagian hero yang melebur ke dalamnya saat digulir +- Bilah kemajuan membaca untuk artikel +- Pengalih tata letak halaman utama interaktif untuk pratinjau langsung +- Agent skill agar agen pemrograman AI (seperti Claude Code) dapat menginstal dan mengonfigurasi tema untuk Anda +- Halaman ramah cetak dengan gaya cetak khusus - Konfigurasi yang sangat dapat disesuaikan - Integrasi Firebase untuk mendukung data dinamis - Penghitung tampilan & mekanisme suka - Artikel terkait -- Beragam tata letak halaman utama - Dukungan untuk banyak penulis - Seri artikel - Penyortiran artikel berdasarkan tanggal dan bobot @@ -40,7 +46,7 @@ Blowfish dirancang sebagai tema yang kuat dan ringan untuk [Hugo](https://gohugo - Daftar isi yang dapat digulir - Dukungan untuk konten multibahasa termasuk bahasa RTL - Kemampuan untuk menautkan ke artikel di situs web pihak ketiga -- Dukungan untuk beberapa shortcode seperti Galeri, Timeline, Kartu GitHub, dan Carousel +- Lebih dari 40 shortcode termasuk Galeri, Timeline, Kartu GitHub, Carousel, Statistik, Grid fitur, Langkah, dan tombol CTA - Sintaks GitHub Alerts, 15 jenis, dukungan lipat - Integrasi BuyMeACoffee - Pencarian situs berbasis klien dengan Fuse.js @@ -74,13 +80,24 @@ Blowfish memiliki [dokumentasi lengkap](https://blowfish.page/docs/) yang mencak Blowfish mendukung beberapa metode instalasi - sebagai submodul git, Modul Hugo, atau instalasi manual sepenuhnya. -Instruksi terperinci untuk setiap metode dapat ditemukan dalam [dokumentasi instalasi](https://blowfish.page/docs/installation). +Instruksi terperinci untuk setiap metode dapat ditemukan dalam [dokumentasi instalasi](https://blowfish.page/docs/installation). Anda sebaiknya membaca dokumentasi untuk pengalaman penyiapan yang paling sederhana. Berikut ini adalah panduan memulai cepat menggunakan submodul jika Anda menggunakan git, atau modul Hugo jika Anda sudah terbiasa menginstal tema Hugo. + +### Instalasi Cepat Menggunakan Agen AI + +Blowfish menyertakan sebuah [agent skill](https://github.com/nunocoracao/blowfish/tree/main/.claude/skills/blowfish) yang mengajarkan agen pemrograman AI — seperti Claude Code — cara menginstal, mengonfigurasi, dan membangun situs dengan tema ini. Instal dari marketplace plugin Blowfish di Claude Code: + +```shell +/plugin marketplace add nunocoracao/blowfish +/plugin install blowfish@blowfish +``` + +Atau cukup salin folder skill ke repositori situs Anda di `.claude/skills/blowfish/` — agen akan mengenali skill proyek secara otomatis. Kemudian minta agen Anda untuk menyiapkan Blowfish untuk Anda. ### Instalasi Cepat Menggunakan Blowfish Tools > **Catatan:** Pastikan Anda sudah menginstal **Node.js**, **Git**, dan **Hugo**, serta telah membuat proyek Hugo sebelum melanjutkan. -Kami baru saja meluncurkan alat CLI baru untuk membantu Anda memulai dengan Blowfish. Ini akan membuat proyek Hugo baru, menginstal tema, dan mengatur file konfigurasi tema untuk Anda. +Blowfish Tools adalah alat CLI yang membantu Anda memulai dengan Blowfish. Alat ini akan membuat proyek Hugo baru, menginstal tema, dan mengatur file konfigurasi tema untuk Anda. Silakan [laporkan masalah apa pun yang Anda temukan](https://github.com/nunocoracao/blowfish-tools). Instal alat CLI secara global menggunakan npm (atau manajer paket lainnya): ```shell @@ -113,17 +130,45 @@ blowfish-tools new mynewsite 3. Hapus file `hugo.toml` di root proyek dan salin file `*.toml` dari tema ke dalam folder `config/_default/`. + Anda akan menemukan file konfigurasi tema ini di direktori cache Hugo, atau [unduh salinannya](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) dari GitHub. + 4. Ikuti petunjuk [Memulai](https://blowfish.page/docs/getting-started/) untuk mengonfigurasi situs web Anda. -### Memperbarui Tema +### Instalasi Cepat Menggunakan Hugo -Untuk memperbarui tema ke rilis terbaru, cukup jalankan perintah berikut di direktori proyek Anda: -```shell -hugo mod get -u -``` +> **Catatan:** Pastikan Anda sudah menginstal **Go** dan **Hugo**, serta telah membuat proyek Hugo baru sebelum melanjutkan. + +1. Dari direktori proyek Anda, inisialisasi Hugo Modules: + ```shell + hugo mod init github.com// + ``` + +2. Buat `config/_default/module.toml` dan tambahkan berikut ini: + ```toml + [[imports]] + path = "github.com/nunocoracao/blowfish/v3" + ``` + +3. Jalankan server Anda menggunakan `hugo server` dan tema akan diunduh secara otomatis. + +4. Di folder root situs web Anda, hapus file `hugo.toml` yang dibuat oleh Hugo. Salin file konfigurasi `*.toml` dari tema ke folder `config/_default/` Anda. + + > **Catatan:** Jangan menimpa file `module.toml` yang Anda buat di atas! + + Anda akan menemukan file konfigurasi tema ini di direktori cache Hugo, atau [unduh salinannya](https://github.com/nunocoracao/blowfish/releases/latest/download/config-default.zip) dari GitHub. + +5. Ikuti petunjuk [Memulai](https://blowfish.page/docs/getting-started/) untuk mengonfigurasi situs web Anda. + +### Menginstal Pembaruan Tema + +Saat rilis baru diterbitkan, Anda dapat memperbarui tema menggunakan Hugo. Cukup jalankan `hugo mod get -u` dari direktori proyek Anda dan tema akan diperbarui secara otomatis ke rilis terbaru. Instruksi pembaruan selengkapnya tersedia dalam [dokumentasi instalasi](https://blowfish.page/docs/installation/#installing-updates). +### Peningkatan dari v2 ke v3 + +Blowfish v3 sepenuhnya kompatibel dengan versi sebelumnya: setiap fitur baru bersifat opsional dan tidak ada opsi konfigurasi atau templat yang dihapus. Instalasi submodul git dan manual diperbarui seperti biasa tanpa perubahan apa pun; pengguna modul Hugo cukup mengubah jalur impor di `config/_default/module.toml` dari `github.com/nunocoracao/blowfish/v2` menjadi `github.com/nunocoracao/blowfish/v3` lalu menjalankan `hugo mod get -u`. Lihat [instruksi peningkatan](https://blowfish.page/docs/installation/#upgrading-from-v2-to-v3) untuk detailnya. + --- ## Kontribusi diff --git a/README.ja.md b/README.ja.md index 105a11ec..014d56a3 100644 --- a/README.ja.md +++ b/README.ja.md @@ -26,14 +26,20 @@ Blowfishは[Hugo](https://gohugo.io)のために設計された強力で軽量 ## 機能 -- Tailwind CSS 3.0 で構築された、完璧なレスポンシブデザイン +- Tailwind CSS 4 で構築された、完璧なレスポンシブデザイン - 複数の配色 (または、自分で完全にカスタマイズ可能) - ダークモード (強制オン/オフ か 自動選択・ユーザー切り替え) +- ヒーロー画像・統計・機能グリッドを備えたプロダクト風ランディングページを含む、複数のホームページレイアウト +- ⌘K / Ctrl+K 検索ショートカット付きのフローティング グラスヘッダー +- スクロールに合わせてヒーローが溶け込むグローバル背景キャンバス +- 記事の読了プログレスバー +- ライブプレビューできるインタラクティブなホームページレイアウト切り替え機能 +- AI コーディングエージェント (Claude Code など) がテーマのインストールと設定を代行できるエージェントスキル +- 専用の印刷スタイルによる印刷に適したページ - 高度なカスタマイズが可能な設定 - Firebase 連携で動的データをサポート - 閲覧数といいね機能 - 関連記事 -- 複数のホームページレイアウト - 複数人の著者 - シリーズ記事 - 日付と価値付けによる記事の並べ替え @@ -44,7 +50,7 @@ Blowfishは[Hugo](https://gohugo.io)のために設計された強力で軽量 - スクロール可能な目次 - RTL 言語を含む多言語コンテンツのサポート - サードパーティー ウェブサイトの投稿へのリンク -- ギャラリー、タイムライン、GitHub カード、カルーセルなど、複数のショートコードに対応 +- ギャラリー、タイムライン、GitHub カード、カルーセル、統計、機能グリッド、ステップ、CTA ボタンなど、40 種類以上のショートコード - GitHub Alerts 構文、15 種類、折りたたみ対応 - Buy Me a Coffee 連携 - Fuse.js を利用したクライアントサイドのサイト内検索 @@ -80,11 +86,22 @@ Blowfish は、git サブモジュール、Hugo モジュール、または完 各方法の詳細な手順は、[インストール](https://blowfish.page/docs/installation)ドキュメントに記載されています。最も簡単なセットアップ方法については、ドキュメントを参照してください。以下にクイックスタートガイドを示します。git を使用している場合はサブモジュール、Hugo テーマのインストールに慣れている場合は Hugo モジュールを使用するのがおすすめです。 +### AI エージェントを使ったクイックスタート + +Blowfish には、AI コーディングエージェント (Claude Code など) にテーマのインストール、設定、サイト構築の方法を教える[エージェントスキル](https://github.com/nunocoracao/blowfish/tree/main/.claude/skills/blowfish)が同梱されています。Claude Code で Blowfish プラグインマーケットプレイスからインストールしてください: + +```shell +/plugin marketplace add nunocoracao/blowfish +/plugin install blowfish@blowfish +``` + +または、スキルフォルダをサイトのリポジトリの `.claude/skills/blowfish/` にコピーするだけでも構いません。エージェントはプロジェクトスキルを自動的に認識します。あとはエージェントに Blowfish のセットアップを依頼してください。 + ### Blowfish Tools を使ったクイックスタート > **注意:** **Node.js**、**Git**、**Hugo** がインストールされていること、そして先に進む前に新しい Hugo プロジェクトが作成されていることを確認してください。 -Blowfish を使い始めるのに役立つ新しい CLI ツールをリリースしました。このツールは、新しい Hugo プロジェクトを作成し、テーマをインストールし、テーマ設定ファイルをセットアップします。まだベータ版なので、[問題を見つけたら報告してください](https://github.com/nunocoracao/blowfish-tools)。 +Blowfish Tools は、Blowfish を使い始めるのに役立つ CLI ツールです。このツールは、新しい Hugo プロジェクトを作成し、テーマをインストールし、テーマ設定ファイルをセットアップします。[問題を見つけたら報告してください](https://github.com/nunocoracao/blowfish-tools)。 npm(または他のパッケージマネージャー)を使って CLI ツールをグローバルにインストールします: ```shell @@ -156,6 +173,10 @@ blowfish-tools new mynewsite 詳細な[アップデート手順](https://blowfish.page/docs/installation/#installing-updates)はドキュメントに記載されています。 +### v2 から v3 へのアップグレード + +Blowfish v3 は完全な後方互換性を備えています。新機能はすべてオプトインで、設定オプションやテンプレートの削除は一切ありません。git サブモジュールや手動インストールの場合は、変更なしで通常どおりアップグレードできます。Hugo モジュールを使用している場合は、`config/_default/module.toml` のインポートパスを `github.com/nunocoracao/blowfish/v2` から `github.com/nunocoracao/blowfish/v3` に変更して `hugo mod get -u` を実行するだけです。詳細は[アップグレード手順](https://blowfish.page/docs/installation/#upgrading-from-v2-to-v3)を参照してください。 + --- ## 貢献 diff --git a/README.pt-br.md b/README.pt-br.md index 5c25f2cd..f3a6a486 100644 --- a/README.pt-br.md +++ b/README.pt-br.md @@ -26,14 +26,20 @@ Blowfish foi projetado para ser um tema poderoso e leve para [Hugo](https://gohu ## Recursos -- Layout totalmente responsivo construído com Tailwind CSS 3.0 +- Layout totalmente responsivo construído com Tailwind CSS 4 - 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) +- Múltiplos layouts de página inicial, incluindo uma landing page estilo produto com imagem hero, estatísticas e grades de recursos +- Cabeçalho flutuante com efeito de vidro e atalho de busca ⌘K / Ctrl+K +- Tela de fundo global com seções hero que se dissolvem nela ao rolar a página +- Barra de progresso de leitura para artigos +- Seletor interativo de layouts da página inicial para pré-visualizações ao vivo +- Skill de agente para que agentes de programação com IA (como o Claude Code) instalem e configurem o tema para você +- Páginas adequadas para impressão com estilos de impressão dedicados - 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 @@ -44,7 +50,7 @@ Blowfish foi projetado para ser um tema poderoso e leve para [Hugo](https://gohu - Í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 +- Mais de 40 shortcodes incluindo Gallery, Timeline, GitHub cards, Carousels, Stats, grades de recursos, Steps e botões CTA - 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 @@ -80,11 +86,22 @@ Blowfish suporta vários métodos de instalação - como submódulo git, Hugo Mo 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 com um agente de IA + +Blowfish inclui um [agent skill](https://github.com/nunocoracao/blowfish/tree/main/.claude/skills/blowfish) que ensina agentes de programação com IA — como o Claude Code — a instalar, configurar e construir sites com o tema. Instale-o a partir do marketplace de plugins do Blowfish no Claude Code: + +```shell +/plugin marketplace add nunocoracao/blowfish +/plugin install blowfish@blowfish +``` + +Ou simplesmente copie a pasta do skill para o repositório do seu site em `.claude/skills/blowfish/` — os agentes detectam skills de projeto automaticamente. Depois peça ao seu agente para configurar o Blowfish para você. + ### 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). +Blowfish Tools é uma ferramenta CLI que ajuda você 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ê. 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 @@ -156,6 +173,10 @@ blowfish-tools new mynewsite [Instruções detalhadas de atualização](https://blowfish.page/docs/installation/#installing-updates) estão disponíveis na documentação. +### Atualizando da v2 para a v3 + +Blowfish v3 é totalmente retrocompatível: todos os novos recursos são opcionais e nenhuma opção de configuração ou template foi removida. As instalações por submódulo git e manuais são atualizadas normalmente, sem alterações; usuários de módulos Hugo só precisam alterar o caminho de importação em `config/_default/module.toml` de `github.com/nunocoracao/blowfish/v2` para `github.com/nunocoracao/blowfish/v3` e executar `hugo mod get -u`. Consulte as [instruções de atualização](https://blowfish.page/docs/installation/#upgrading-from-v2-to-v3) para mais detalhes. + --- ## Contribuindo diff --git a/README.pt-pt.md b/README.pt-pt.md index 19376972..7893ee43 100644 --- a/README.pt-pt.md +++ b/README.pt-pt.md @@ -26,14 +26,20 @@ Blowfish foi desenhado para ser um tema poderoso e leve para [Hugo](https://gohu ## Funcionalidades -- Layout totalmente responsivo construído com Tailwind CSS 3.0 +- Layout totalmente responsivo construído com Tailwind CSS 4 - 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) +- Múltiplos layouts de página inicial, incluindo uma landing page de estilo produto com imagem hero, estatísticas e grelhas de funcionalidades +- Cabeçalho flutuante com efeito de vidro e atalho de pesquisa ⌘K / Ctrl+K +- Tela de fundo global com secções hero que se dissolvem nela ao fazer scroll +- Barra de progresso de leitura para artigos +- Seletor interativo de layouts da página inicial para pré-visualizações em direto +- Skill de agente para que agentes de programação com IA (como o Claude Code) instalem e configurem o tema por si +- Páginas adequadas para impressão com estilos de impressão dedicados - 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 @@ -44,7 +50,7 @@ Blowfish foi desenhado para ser um tema poderoso e leve para [Hugo](https://gohu - Í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 +- Mais de 40 shortcodes incluindo Gallery, Timeline, GitHub cards, Carousels, Stats, grelhas de funcionalidades, Steps e botões CTA - Sintaxe GitHub Alerts, 15 tipos, suporte para elementos expansíveis - Integração Buymeacoffee - Pesquisa no site do lado do cliente alimentada por Fuse.js @@ -80,11 +86,22 @@ Blowfish suporta vários métodos de instalação - como um submódulo git, um M 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 com um agente de IA + +Blowfish inclui um [agent skill](https://github.com/nunocoracao/blowfish/tree/main/.claude/skills/blowfish) que ensina agentes de programação com IA — como o Claude Code — a instalar, configurar e construir sites com o tema. Instale-o a partir do marketplace de plugins do Blowfish no Claude Code: + +```shell +/plugin marketplace add nunocoracao/blowfish +/plugin install blowfish@blowfish +``` + +Ou simplesmente copie a pasta do skill para o repositório do seu site em `.claude/skills/blowfish/` — os agentes detetam skills de projeto automaticamente. Depois peça ao seu agente para configurar o Blowfish por si. + ### 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). +Blowfish Tools é uma ferramenta CLI que o ajuda 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. Por favor [reporte quaisquer problemas que encontrar](https://github.com/nunocoracao/blowfish-tools). Instale a ferramenta CLI globalmente usando npm (ou outro gestor de pacotes): ```shell @@ -156,6 +173,10 @@ blowfish-tools new mynewsite [Instruções detalhadas de atualização](https://blowfish.page/docs/installation/#installing-updates) estão disponíveis na documentação. +### Atualização da v2 para a v3 + +Blowfish v3 é totalmente retrocompatível: todas as novas funcionalidades são opcionais e nenhuma opção de configuração ou template foi removida. As instalações por submódulo git e manuais atualizam-se como habitualmente, sem alterações; os utilizadores de módulos Hugo apenas precisam de alterar o caminho de importação em `config/_default/module.toml` de `github.com/nunocoracao/blowfish/v2` para `github.com/nunocoracao/blowfish/v3` e executar `hugo mod get -u`. Consulte as [instruções de atualização](https://blowfish.page/docs/installation/#upgrading-from-v2-to-v3) para mais detalhes. + --- ## Contribuir diff --git a/README.zh-cn.md b/README.zh-cn.md index 160b04b4..610b662e 100644 --- a/README.zh-cn.md +++ b/README.zh-cn.md @@ -26,14 +26,20 @@ Blowfish 是一个轻量有力的 Hugo 主题。它使用 Tailwind CSS 构建, ## 特性 -- 使用 Tailwind CSS 3.0 构建全面响应式布局 +- 使用 Tailwind CSS 4 构建全面响应式布局 - 多种配色方案,亦可完全由你定义 - 夜间模式支持(手动开启/关闭或根据用户设备自动切换) +- 多种主页布局,包括带有主视觉图、数据统计和功能网格的产品风格着陆页 +- 悬浮玻璃质感页眉,支持 ⌘K / Ctrl+K 搜索快捷键 +- 全局背景画布,主视觉区域随滚动溶入其中 +- 文章阅读进度条 +- 可实时预览的交互式主页布局切换器 +- 内置代理技能(agent skill),让 AI 编程代理(如 Claude Code)为你安装和配置主题 +- 配备专用打印样式的打印友好页面 - 高度自主的配置方式 - 集成 Firebase 以支持动态数据统计 - 集成浏览次数统计和点赞机制 - “相关文章”列表生成 -- 多种主页布局 - 多作者模式支持 - 可将文章整理成选集列表 - 禅模式支持 @@ -42,7 +48,7 @@ Blowfish 是一个轻量有力的 Hugo 主题。它使用 Tailwind CSS 构建, - 支持嵌套菜单和子导航菜单 - 支持多语言内容,包括 RTL 语言 - 可链接到第三方网站上的帖子 -- 支持多种简码,如图库、时间轴、GitHub 卡片和图片灯箱 +- 内置 40 多种简码,包括图库、时间轴、GitHub 卡片、轮播、数据统计、功能网格、步骤和 CTA 按钮 - 支持 GitHub Alerts 语法、15 种类型和可折叠功能 - 支持 Buymeacoffee - 拥有由 Fuse.js 支持的客户端一侧网站搜索功能 @@ -77,11 +83,22 @@ Blowfish 支持多种安装方式,既能作为 git 子模块、Hugo 模块, 每种方法的详细说明都可以在 [安装](https://blowfish.page/zh-cn/docs/installation) 文档中找到。为了获得最简单的安装体验,请查阅文档。如果你使用的是 git,请阅读下面使用子模块的快速开始指南;如果你能安装 Hugo 主题,请阅读下面 Hugo 模块的快速开始指南。 +### 使用 AI 代理快速开始 + +Blowfish 内置了一个[代理技能(agent skill)](https://github.com/nunocoracao/blowfish/tree/main/.claude/skills/blowfish),可以教 AI 编程代理(如 Claude Code)如何安装、配置主题并用它构建网站。在 Claude Code 中通过 Blowfish 插件市场安装: + +```shell +/plugin marketplace add nunocoracao/blowfish +/plugin install blowfish@blowfish +``` + +或者直接将技能文件夹复制到你网站仓库的 `.claude/skills/blowfish/` 目录中——代理会自动识别项目技能。然后让你的代理为你完成 Blowfish 的设置。 + ### 使用 Blowfish Tools 快速开始 > **注:** 请确保你已安装 **Node.js**、 **Git** 和 **Hugo** ,且已经创建了一个 Hugo 工程。 -我们最新推出了一个新的 CLI 工具,帮助你开始使用 Blowfish。它将为你创建一个新的 Hugo 项目、安装主题并设置主题配置文件。它仍处于测试阶段,因此请 [报告你发现的任何问题](https://github.com/nunocoracao/blowfish-tools)。 +Blowfish Tools 是一个帮助你开始使用 Blowfish 的 CLI 工具。它将为你创建一个新的 Hugo 项目、安装主题并设置主题配置文件。请 [报告你发现的任何问题](https://github.com/nunocoracao/blowfish-tools)。 使用 npm(或其他软件包管理器)全局安装 CLI 工具: ```shell @@ -153,6 +170,10 @@ blowfish-tools new mynewsite 详细的[更新指南](https://blowfish.page/zh-cn/docs/installation/#%E6%9B%B4%E6%96%B0%E4%B8%BB%E9%A2%98)在文档中。 +### 从 v2 升级到 v3 + +Blowfish v3 完全向后兼容:所有新功能均为可选启用,没有删除任何配置选项或模板。git 子模块和手动安装的用户按常规方式升级即可,无需任何改动;Hugo 模块用户只需将 `config/_default/module.toml` 中的导入路径从 `github.com/nunocoracao/blowfish/v2` 改为 `github.com/nunocoracao/blowfish/v3`,然后运行 `hugo mod get -u`。详情请参阅[升级指南](https://blowfish.page/docs/installation/#upgrading-from-v2-to-v3)。 + --- ## 贡献