From 0838f77b36b67576965ec6438fc56aee30fa1eb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nuno=20Cora=C3=A7=C3=A3o?= Date: Fri, 12 Apr 2024 12:50:37 +0100 Subject: [PATCH] updated installation documentation --- config/_default/hugo.toml | 2 +- exampleSite/config/_default/hugo.toml | 2 +- .../content/docs/getting-started/index.it.md | 2 +- exampleSite/content/docs/installation/index.it.md | 14 +++++++------- exampleSite/content/docs/installation/index.ja.md | 14 +++++++------- exampleSite/content/docs/installation/index.md | 14 +++++++------- .../content/docs/installation/index.zh-cn.md | 14 +++++++------- 7 files changed, 31 insertions(+), 31 deletions(-) diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml index 968d4def..5f921347 100644 --- a/config/_default/hugo.toml +++ b/config/_default/hugo.toml @@ -2,7 +2,7 @@ # Refer to the theme docs for more details about each of these parameters. # https://blowfish.page/docs/getting-started/ -theme = "blowfish" +# theme = "blowfish" # UNCOMMENT THIS LINE # baseURL = "https://your_domain.com/" defaultContentLanguage = "en" diff --git a/exampleSite/config/_default/hugo.toml b/exampleSite/config/_default/hugo.toml index bef472bd..d058b6da 100644 --- a/exampleSite/config/_default/hugo.toml +++ b/exampleSite/config/_default/hugo.toml @@ -5,7 +5,7 @@ theme = "blowfish" baseURL = "https://localhost:1313" defaultContentLanguage = "en" -disableLanguages = ['it'] #to allow translation work requiring shipping to production +disableLanguages = [] #to allow translation work requiring shipping to production # pluralizeListTitles = "true" # hugo function useful for non-english languages, find out more in https://gohugo.io/getting-started/configuration/#pluralizelisttitles diff --git a/exampleSite/content/docs/getting-started/index.it.md b/exampleSite/content/docs/getting-started/index.it.md index dcefb455..04448d73 100644 --- a/exampleSite/content/docs/getting-started/index.it.md +++ b/exampleSite/content/docs/getting-started/index.it.md @@ -2,7 +2,7 @@ title: "Per iniziare" date: 2020-08-15 draft: false -description: "Tutte le variabili del front matter sono disponibili in Blowfish. +description: "Tutte le variabili del front matter sono disponibili in Blowfish." slug: "per-iniziare" tags: ["installazione", "documenti"] series: ["Documentazione"] diff --git a/exampleSite/content/docs/installation/index.it.md b/exampleSite/content/docs/installation/index.it.md index eb71b365..abc878a9 100644 --- a/exampleSite/content/docs/installation/index.it.md +++ b/exampleSite/content/docs/installation/index.it.md @@ -54,7 +54,7 @@ Ecco un rapido video che ti mostra quanto sia veloce iniziare a utilizzare Blowf -### Installazione Manuale +### Installazione senza CLI #### Crea un novo sito @@ -72,7 +72,7 @@ Esistono diversi modi per installare il tema Blowfish nel proprio sito web Hugo. Se non sei sicuro, scegli il metodo Git submodule. -##### Installazione usando Git +#### Installazione usando Git Questo è il metodo piu facile e veloce per mantere il tema aggiornato. Oltre **Hugo** e **Go**, dovrai assicurarti di avere **Git** installato nel tuo local machine. @@ -86,7 +86,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo poi continua a [impostare i file di configurazione del tema](#set-up-theme-configuration-files). -##### Installazione usando Hugo +#### Installazione usando Hugo Per questo metodo utilizzerai Hugo per gestire i tuoi temi. Hugo utilizza **Go** per inizializzare e gestire i moduli, quindi assicurati di aver installato `go` prima di procedere. @@ -116,7 +116,7 @@ Per questo metodo utilizzerai Hugo per gestire i tuoi temi. Hugo utilizza **Go** 4. Avvia il tuo server utilizzando `hugo server` e il tema verrà scaricato automaticamente. 5. Continua con [impostare i file di configurazione del tema](#set-up-theme-configuration-files). -##### Installazione manuale +#### Installazione manuale 1. Scarica l'ultima versione del codice sorgente del tema. {{< button href="https://github.com/nunocoracao/blowfish/releases/latest" target="_blank" >}}Scarica da Github{{< /button >}} @@ -127,7 +127,7 @@ Per questo metodo utilizzerai Hugo per gestire i tuoi temi. Hugo utilizza **Go** #### Imposta i file di configurazione del tema -Nella cartella principale del tuo sito web, elimina il file `config.toml` generato da Hugo. Copia i file di configurazione `*.toml` dal tema nella tua cartella `config/_default/`. Ciò ti garantirà di avere tutte le impostazioni corrette del tema e ti consentirà di personalizzare facilmente il tema in base alle tue esigenze. +Nella cartella principale del tuo sito web, elimina il file `hugo.toml` generato da Hugo. Copia i file di configurazione `*.toml` dal tema nella tua cartella `config/_default/`. Ciò ti garantirà di avere tutte le impostazioni corrette del tema e ti consentirà di personalizzare facilmente il tema in base alle tue esigenze. {{< alert >}} **Note:** Non dovresti sovrascrivere il file `module.toml` se ne esiste già uno nel tuo progetto! @@ -142,7 +142,7 @@ Una volta che hai copiato i file, la tua cartella delle configurazioni dovrebbe ```shell config/_default/ -├─ config.toml +├─ hugo.toml ├─ languages.en.toml ├─ markup.toml ├─ menus.en.toml @@ -151,7 +151,7 @@ config/_default/ ``` {{< alert >}} -**Importante:** Se non hai utilizzato Hugo Modules per installare Blowfish, devi aggiungere la riga `theme = "blowfish"` all'inizio del tuo file `config.toml`. +**Importante:** Se non hai utilizzato Hugo Modules per installare Blowfish, devi aggiungere la riga `theme = "blowfish"` all'inizio del tuo file `hugo.toml`. {{< /alert >}} ### Passo successivo diff --git a/exampleSite/content/docs/installation/index.ja.md b/exampleSite/content/docs/installation/index.ja.md index fd367e8b..433ae24b 100644 --- a/exampleSite/content/docs/installation/index.ja.md +++ b/exampleSite/content/docs/installation/index.ja.md @@ -55,7 +55,7 @@ Here's a quick video of how fast it is to get started with Blowfish using the CL -### Install Manually +### Install without CLI #### Create a new site @@ -73,7 +73,7 @@ There several different ways to install the Blowfish theme into your Hugo websit If you're unsure, choose the Git submodule method. -##### Install using git +#### Install using git This method is the quickest and easiest for keeping the theme up-to-date. Besides **Hugo** and **Go**, you'll also need to ensure you have **Git** installed on your local machine. @@ -87,7 +87,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo Then continue to [set up the theme configuration files](#set-up-theme-configuration-files). -##### Install using Hugo +#### Install using Hugo For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initialise and manage modules so you need to ensure you have `go` installed before proceeding. @@ -117,7 +117,7 @@ For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initi 4. Start your server using `hugo server` and the theme will be downloaded automatically. 5. Continue to [set up the theme configuration files](#set-up-theme-configuration-files). -##### Install manually +#### Install manually 1. Download the latest release of the theme source code. @@ -128,7 +128,7 @@ For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initi #### Set up theme configuration files -In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme to your needs. +In the root folder of your website, delete the `hugo.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme to your needs. {{< alert >}} **Note:** You should not overwrite the `module.toml` file if one already exists in your project! @@ -143,7 +143,7 @@ Once you've copied the files, your config folder should look like this: ```shell config/_default/ -├─ config.toml +├─ hugo.toml ├─ languages.en.toml ├─ markup.toml ├─ menus.en.toml @@ -152,7 +152,7 @@ config/_default/ ``` {{< alert >}} -**Important:** If you didn't use Hugo Modules to install Blowfish, you must add the line `theme = "blowfish"` to the top of your `config.toml` file. +**Important:** If you didn't use Hugo Modules to install Blowfish, you must add the line `theme = "blowfish"` to the top of your `hugo.toml` file. {{< /alert >}} ### Next steps diff --git a/exampleSite/content/docs/installation/index.md b/exampleSite/content/docs/installation/index.md index fd367e8b..433ae24b 100644 --- a/exampleSite/content/docs/installation/index.md +++ b/exampleSite/content/docs/installation/index.md @@ -55,7 +55,7 @@ Here's a quick video of how fast it is to get started with Blowfish using the CL -### Install Manually +### Install without CLI #### Create a new site @@ -73,7 +73,7 @@ There several different ways to install the Blowfish theme into your Hugo websit If you're unsure, choose the Git submodule method. -##### Install using git +#### Install using git This method is the quickest and easiest for keeping the theme up-to-date. Besides **Hugo** and **Go**, you'll also need to ensure you have **Git** installed on your local machine. @@ -87,7 +87,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo Then continue to [set up the theme configuration files](#set-up-theme-configuration-files). -##### Install using Hugo +#### Install using Hugo For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initialise and manage modules so you need to ensure you have `go` installed before proceeding. @@ -117,7 +117,7 @@ For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initi 4. Start your server using `hugo server` and the theme will be downloaded automatically. 5. Continue to [set up the theme configuration files](#set-up-theme-configuration-files). -##### Install manually +#### Install manually 1. Download the latest release of the theme source code. @@ -128,7 +128,7 @@ For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initi #### Set up theme configuration files -In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme to your needs. +In the root folder of your website, delete the `hugo.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme to your needs. {{< alert >}} **Note:** You should not overwrite the `module.toml` file if one already exists in your project! @@ -143,7 +143,7 @@ Once you've copied the files, your config folder should look like this: ```shell config/_default/ -├─ config.toml +├─ hugo.toml ├─ languages.en.toml ├─ markup.toml ├─ menus.en.toml @@ -152,7 +152,7 @@ config/_default/ ``` {{< alert >}} -**Important:** If you didn't use Hugo Modules to install Blowfish, you must add the line `theme = "blowfish"` to the top of your `config.toml` file. +**Important:** If you didn't use Hugo Modules to install Blowfish, you must add the line `theme = "blowfish"` to the top of your `hugo.toml` file. {{< /alert >}} ### Next steps diff --git a/exampleSite/content/docs/installation/index.zh-cn.md b/exampleSite/content/docs/installation/index.zh-cn.md index 6338a5a5..eb094436 100644 --- a/exampleSite/content/docs/installation/index.zh-cn.md +++ b/exampleSite/content/docs/installation/index.zh-cn.md @@ -54,7 +54,7 @@ blowfish-tools new mynewsite -### 手动安装 +### 无需 CLI 的安装 #### 创建新站点 @@ -72,7 +72,7 @@ blowfish-tools new mynewsite 如果你不确定用哪一个，请直接选择 Git 子模块的方式。 -##### 使用 Git 子模块安装 +#### 使用 Git 子模块安装 这个方法可以保证主题简单且快速地安装和更新。除了 **Hugo** 和 **Go**，你还需要确保本地机器安装了 **Git**。 @@ -86,7 +86,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo 然后 [设置主题的配置文件](#set-up-theme-configuration-files)。 -##### 使用 Hugo 模板安装 +#### 使用 Hugo 模板安装 这种方法是使用 Hugo 来管理你的主题，Hugo 使用 **Go** 来初始化和管理模块，所以首先需要确保已经安装了`go`。 @@ -116,7 +116,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo 4. 使用`hugo server` 命令后，主题将会自动下载。 5. 然后 [设置主题的配置文件](#set-up-theme-configuration-files). -##### 手动复制文件 +#### 手动复制文件 1. 下载最新的主题源码。 @@ -127,7 +127,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo #### 设置主题的配置文件 -在你的网站根目录中，删除 Hugo 自动生成的 `config.toml` 文件。从主题中复制 `*.toml` 文件，粘贴到 `config/_default/` 目录中。这将确保你的主题设置准确无误，在此基础上你能够轻松地自定义主题。 +在你的网站根目录中，删除 Hugo 自动生成的 `hugo.toml` 文件。从主题中复制 `*.toml` 文件，粘贴到 `config/_default/` 目录中。这将确保你的主题设置准确无误，在此基础上你能够轻松地自定义主题。 {{< alert >}} **注意:** 如果项目中已经存在 `module.toml` 文件，请不要覆盖它！ @@ -142,7 +142,7 @@ git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blo ```shell config/_default/ -├─ config.toml +├─ hugo.toml ├─ languages.en.toml ├─ markup.toml ├─ menus.en.toml @@ -151,7 +151,7 @@ config/_default/ ``` {{< alert >}} -**重要:** 如果你没有使用 Hugo 模块安装 Blowfish，那么你必须在 `config.toml` 文件中添加 `theme = "blowfish"`。 +**重要:** 如果你没有使用 Hugo 模块安装 Blowfish，那么你必须在 `hugo.toml` 文件中添加 `theme = "blowfish"`。 {{< /alert >}} ### 下一步