polish and added documentation for new cli tool

This commit is contained in:
Nuno Coração
2024-01-14 23:51:51 +00:00
parent bb2968a41d
commit 8f31c4f834
86 changed files with 126 additions and 69 deletions

View File

@@ -27,13 +27,34 @@ Make sure you are using **Hugo version 0.87.0** or later as the theme takes adva
You can find detailed installation instructions for your platform in the [Hugo docs](https://gohugo.io/getting-started/installing).
### Create a new site
### Install with Blowfish Tools (Beta)
We just launched a new CLI tool to help you get started with Blowfish. It will create a new Hugo project, install the theme and set up the theme configuration files for you. It's still in beta so please [report any issues you find](https://github.com/nunocoracao/blowfish-tools).
Install the CLI tool globally using npm (or other package manager):
```shell
npm i -g blowfish-tools
```
Then run the command `blowfish-tools` to start an interactive run which will guide you through creation and configuration use-cases.
```shell
blowfish-tools
```
You can also run the command `blowfish-tools new` to create a new Hugo project and install the theme in one go. Check the CLI help for more information.
```shell
blowfish-tools new mynewsite
```
### Install Manually
#### Create a new site
Run the command `hugo new site mywebsite` to create a new Hugo site in a directory named `mywebsite`.
Note that you can name the project directory whatever you choose, but the instructions below will assume it's named `mywebsite`. If you use a different name, be sure to substitute it accordingly.
### Download the Blowfish theme
#### Download the Blowfish theme
There several different ways to install the Blowfish theme into your Hugo website. From easiest to most difficult to install and maintain, they are:
@@ -43,7 +64,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.
@@ -57,7 +78,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.
@@ -87,7 +108,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.
@@ -96,7 +117,7 @@ For this method you'll use Hugo to manage your themes. Hugo uses **Go** to initi
2. Extract the archive, rename the folder to `blowfish` and move it to the `themes/` directory inside your Hugo project's root folder.
3. Continue to [set up the theme configuration files](#set-up-theme-configuration-files).
### Set up theme configuration files
#### 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.