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

@ -71,6 +71,27 @@ Blowfish supports several installation methods - as a git submodule, a Hugo Modu
Detailed instructions for each method can be found in the [Installation](https://blowfish.page/docs/installation) docs. You should consult the documentation for the simplest setup experience. Below is a quick start guide using submodules if you are using git, or Hugo modules if you're already confident installing Hugo themes.
### Quick start using Blowfish Tools
> **Note:** Ensure you have **Node.js**, **Git**, **Go** and **Hugo** installed, and that you have created a new Hugo project before proceeding.
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
```
### Quick start using git submodules
> **Note:** Ensure you have **Git**, **Go**, and **Hugo** installed, and that you have created a new Hugo project before proceeding.

View file

@ -1,9 +1,11 @@
---
title: "Welcome to Blowfish! :tada:"
description: "This is a demo of the Blowfish theme for Hugo."
description: "This page was built using the Blowfish theme for Hugo."
---
This is a demo site built entirely using Blowfish. It also contains a complete set of [theme documentation]({{< ref "docs" >}}). Blowfish is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.
Welcome to Blowfish, one of the most flexible and robust Hugo themes. Here you can find the complete [theme documentation]({{< ref "docs" >}}). Blowfish is highly customizable and can be configured to fit your needs: from a static website to a blog. Checkout some [examples](/examples) and what some of our [users](/users) have been building.
Explore the [sample pages]({{< ref "samples" >}}) to get a feel for what Blowfish can do. If you like what you see, check out the project on <a target="_blank" href="https://github.com/nunocoracao/blowfish">Github</a> or read the [Installation guide]({{< ref "docs/installation" >}}) to get started.
<div class="flex px-4 py-2 mb-8 text-base rounded-md bg-primary-100 dark:bg-primary-900">
<span class="flex items-center ltr:pr-3 rtl:pl-3 text-primary-400">
@ -20,4 +22,4 @@ This is a demo site built entirely using Blowfish. It also contains a complete s
</span>
</div>
Explore the [sample pages]({{< ref "samples" >}}) to get a feel for what Blowfish can do. If you like what you see, check out the project on <a target="_blank" href="https://github.com/nunocoracao/blowfish">Github</a> or read the [Installation guide]({{< ref "docs/installation" >}}) to get started.

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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 55 KiB

View file

@ -2,7 +2,7 @@
title: "50-nuances-octets.fr"
tags: [Organization site]
externalUrl: "https://www.50-nuances-octets.fr/"
date: 9952-08-08
date: 9954-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 79 KiB

View file

@ -2,7 +2,7 @@
title: "BoringTech.net"
tags: [Personal Site,Blog]
externalUrl: "https://boringtech.net/"
date: 9928-08-08
date: 9930-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "adilhyz.github.io"
tags: [Personal site]
externalUrl: "https://adilhyz.github.io"
date: 9939-08-08
date: 9941-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "adir1.com"
tags: [Personal site]
externalUrl: "https://adir1.com/"
date: 9973-08-08
date: 9975-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "alanctanner.com"
tags: [Personal site]
externalUrl: "https://alanctanner.com/"
date: 9962-08-08
date: 9964-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "alejandro-ao.com"
tags: [Personal site]
externalUrl: "https://alejandro-ao.com/"
date: 9974-08-08
date: 9976-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "alxhslm.github.io"
tags: [Personal Site]
externalUrl: "https://alxhslm.github.io/"
date: 9925-08-08
date: 9927-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "bbagwang.com"
tags: [Personal site]
externalUrl: "https://bbagwang.com"
date: 9945-08-08
date: 9947-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View file

@ -2,7 +2,7 @@
title: "binarydigit.cafe"
tags: [Personal site]
externalUrl: "https://binarydigit.cafe/"
date: 9926-08-08
date: 9928-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "blastomussa.dev"
tags: [Personal site]
externalUrl: "https://blastomussa.dev"
date: 9980-08-08
date: 9982-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 84 KiB

After

Width:  |  Height:  |  Size: 79 KiB

View file

@ -2,7 +2,7 @@
title: "blog.enmanuelmoreira.com"
tags: [Personal site]
externalUrl: "https://blog.enmanuelmoreira.com"
date: 9954-08-08
date: 9956-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 170 KiB

After

Width:  |  Height:  |  Size: 171 KiB

View file

@ -2,7 +2,7 @@
title: "blog.muffn.io"
tags: [Personal site]
externalUrl: "https://blog.muffn.io/"
date: 9971-08-08
date: 9973-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "blog.stonegarden.dev"
tags: [Personal Site]
externalUrl: "https://blog.stonegarden.dev/"
date: 9930-08-08
date: 9932-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "cdell.io"
tags: [Personal site]
externalUrl: "https://cdell.io"
date: 9979-08-08
date: 9981-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "clemsau.com"
tags: [Personal site]
externalUrl: "https://clemsau.com/"
date: 9958-08-08
date: 9960-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "ctulhu.me"
tags: [Personal site]
externalUrl: "https://ctulhu.me"
date: 9932-08-08
date: 9934-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "deepumohan.com/tech"
tags: [Technology Blog]
externalUrl: "https://deepumohan.com/tech/"
date: 9936-08-08
date: 9938-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 36 KiB

View file

@ -2,7 +2,7 @@
title: "dizzytech.de"
tags: [Personal site]
externalUrl: "https://dizzytech.de"
date: 9975-08-08
date: 9977-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View file

@ -2,7 +2,7 @@
title: "fm126.top"
tags: [Personal site,Blog]
externalUrl: "https://fm126.top/"
date: 9924-08-08
date: 9926-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "fugugames.com"
tags: [Games site]
externalUrl: "https://fugugames.com/"
date: 9965-08-08
date: 9967-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "gma.name"
tags: [Personal site]
externalUrl: "https://gma.name"
date: 9942-08-08
date: 9944-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "halcyonstraits.com"
tags: [Doll photography]
externalUrl: "https://www.halcyonstraits.com/"
date: 9953-08-08
date: 9955-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "hellstabber.github.io"
tags: [Personal site]
externalUrl: "https://hellstabber.github.io/"
date: 9959-08-08
date: 9961-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "hyperbowl3d.com"
tags: [Game site]
externalUrl: "https://hyperbowl3d.com/"
date: 9964-08-08
date: 9966-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "insidemordecai.com"
tags: [Personal site]
externalUrl: "https://insidemordecai.com"
date: 9982-08-08
date: 9984-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View file

@ -2,7 +2,7 @@
title: "jam.dsg.li"
tags: [Organization site]
externalUrl: "https://jam.dsg.li"
date: 9978-08-08
date: 9980-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "jamesdixon.dev"
tags: [Personal site]
externalUrl: "https://jamesdixon.dev"
date: 9981-08-08
date: 9983-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "jamiemoxon.tech"
tags: [Personal site]
externalUrl: "https://jamiemoxon.tech"
date: 9944-08-08
date: 9946-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "joush007.github.io"
tags: [Personal Site]
externalUrl: "https://joush007.github.io"
date: 9934-08-08
date: 9936-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "jundimubarok.com"
tags: [Personal site]
externalUrl: "https://jundimubarok.com/"
date: 9947-08-08
date: 9949-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "kylemalloy.com"
tags: [Personal site]
externalUrl: "https://kylemalloy.com"
date: 9935-08-08
date: 9937-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

After

Width:  |  Height:  |  Size: 116 KiB

View file

@ -2,7 +2,7 @@
title: "lelouvincx.github.io"
tags: [Personal site]
externalUrl: "https://lelouvincx.github.io/"
date: 9957-08-08
date: 9959-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

After

Width:  |  Height:  |  Size: 45 KiB

View file

@ -2,7 +2,7 @@
title: "m3upt.com"
tags: [Project site]
externalUrl: "https://m3upt.com"
date: 9949-08-08
date: 9951-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 32 KiB

View file

@ -2,7 +2,7 @@
title: "mariuskimmina.com"
tags: [Personal site]
externalUrl: "https://mariuskimmina.com/"
date: 9967-08-08
date: 9969-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 88 KiB

View file

@ -2,7 +2,7 @@
title: "marupanda.art/marucomics"
tags: [Comics site]
externalUrl: "https://marupanda.art/marucomics/"
date: 9951-08-08
date: 9953-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "mayer.life"
tags: [Personal site]
externalUrl: "https://mayer.life"
date: 9941-08-08
date: 9943-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "muhalvin.github.io"
tags: [Personal site]
externalUrl: "https://muhalvin.github.io/"
date: 9968-08-08
date: 9970-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

View file

@ -2,7 +2,7 @@
title: "nick.bouwhuis.net"
tags: [Personal site]
externalUrl: "https://nick.bouwhuis.net"
date: 9970-08-08
date: 9972-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View file

@ -2,7 +2,7 @@
title: "nikarashihatsu.github.io"
tags: [Personal site]
externalUrl: "https://nikarashihatsu.github.io/"
date: 9955-08-08
date: 9957-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "niklas-hartmann-dev.de"
tags: [Personal site]
externalUrl: "https://niklas-hartmann-dev.de/"
date: 9972-08-08
date: 9974-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "ohdmire.github.io"
tags: [Personal site]
externalUrl: "https://ohdmire.github.io"
date: 9938-08-08
date: 9940-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "omarohn.de"
tags: [Personal site]
externalUrl: "https://omarohn.de"
date: 9984-08-08
date: 9985-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 81 KiB

View file

@ -2,7 +2,7 @@
title: "pacochan.net"
tags: [Personal site]
externalUrl: "https://pacochan.net"
date: 9948-08-08
date: 9950-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "priyakdey.com"
tags: [Personal site]
externalUrl: "https://priyakdey.com"
date: 9977-08-08
date: 9979-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "rdgo.dev"
tags: [Personal site]
externalUrl: "https://rdgo.dev/"
date: 9961-08-08
date: 9963-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "rejowski.xyz"
tags: [Personal Site]
externalUrl: "https://rejowski.xyz/"
date: 9933-08-08
date: 9935-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "renaud.warnotte.be"
tags: [Personal site]
externalUrl: "https://renaud.warnotte.be"
date: 9929-08-08
date: 9931-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View file

@ -2,7 +2,7 @@
title: "ricklan.photography"
tags: [Personal site]
externalUrl: "https://ricklan.photography"
date: 9937-08-08
date: 9939-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "scottmckendry.tech"
tags: [Personal site]
externalUrl: "https://scottmckendry.tech"
date: 9940-08-08
date: 9942-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "sdehm.dev"
tags: [Personal site]
externalUrl: "https://sdehm.dev"
date: 9976-08-08
date: 9978-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "seanomahoney.com"
tags: [Personal site]
externalUrl: "https://seanomahoney.com/"
date: 9950-08-08
date: 9952-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View file

@ -2,7 +2,7 @@
title: "shenshu.fun"
tags: [Personal site]
externalUrl: "https://shenshu.fun/"
date: 9960-08-08
date: 9962-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "talkdimsum.com"
tags: [App site]
externalUrl: "https://talkdimsum.com/"
date: 9963-08-08
date: 9965-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "technicaldc.github.io"
tags: [Personal Site,Blog]
externalUrl: "https://technicaldc.github.io/"
date: 9927-08-08
date: 9929-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "technicat.com"
tags: [Company site]
externalUrl: "https://technicat.com/"
date: 9966-08-08
date: 9968-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

View file

@ -0,0 +1,13 @@
---
title: "the-maze.net"
tags: [Personal site,Blog]
externalUrl: "https://www.the-maze.net/"
date: 9925-08-08
showDate: false
showAuthor: false
showReadingTime: false
showEdit: false
showLikes: false
showViews: false
layoutBackgroundHeaderSpace: false
---

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 79 KiB

View file

@ -2,7 +2,7 @@
title: "theindiecoder.cloud"
tags: [Personal site]
externalUrl: "https://theindiecoder.cloud"
date: 9943-08-08
date: 9945-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB

View file

@ -2,7 +2,7 @@
title: "v-y-s.com"
tags: [Personal Site]
externalUrl: "https://v-y-s.com/"
date: 9931-08-08
date: 9933-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "vividscc.com"
tags: [Business site]
externalUrl: "https://vividscc.com/"
date: 9969-08-08
date: 9971-08-08
showDate: false
showAuthor: false
showReadingTime: false

View file

@ -2,7 +2,7 @@
title: "vkmki001.github.io"
tags: [Personal site]
externalUrl: "https://vkmki001.github.io/"
date: 9946-08-08
date: 9948-08-08
showDate: false
showAuthor: false
showReadingTime: false

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 74 KiB

View file

@ -2,7 +2,7 @@
title: "weaxsey.org"
tags: [Personal site]
externalUrl: "https://weaxsey.org/"
date: 9956-08-08
date: 9958-08-08
showDate: false
showAuthor: false
showReadingTime: false