dbrun/blowfish
1
0
Fork 0
mirror of https://github.com/nunocoracao/blowfish.git synced 2026-01-30 16:31:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

updated installation documentation

Browse Source
This commit is contained in:
Nuno Coração
2024-04-12 12:50:37 +01:00
parent bc12f64ac7
commit 0838f77b36
7 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
exampleSite/content/docs/installation/index.md
View File

@@ -55,7 +55,7 @@ Here's a quick video of how fast it is to get started with Blowfish using the CL
<iframe width="100%" height="350" src="https://www.youtube.com/embed/SgXhGb-7QbU?si=ce44baicuQ6zMeXz" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
### 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