Skip to content

Commit

Permalink
Merge pull request #1169 from nunocoracao/dev
Browse files Browse the repository at this point in the history
🔖 2.51.0
  • Loading branch information
nunocoracao authored Jan 19, 2024
2 parents 9818cfd + 71b578b commit 0a9b4a2
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 19 deletions.
11 changes: 7 additions & 4 deletions exampleSite/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@ title: "Welcome to Blowfish! :tada:"
description: "This page was built using the Blowfish theme for Hugo."
---

Welcome to Blowfish, one of the most flexible and robust Hugo themes. It is designed to be simple, fast and content-focused. Learn how to get started:
Welcome to Blowfish, one of the most flexible and robust Hugo themes. It is designed to be simple, fast and content-focused. Learn more about how to install [here]({{< ref "docs/installation" >}}) or get started with our CLI using:

{{< article link="/docs/installation/" >}}
```node
npx blowfish-tools
```
<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>

You can also find the complete theme documentation in [docs]({{< 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.
<!--You can also find the complete theme documentation in [docs]({{< 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 [shortcode list]({{< ref "docs/shortcodes" >}}) and [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.
Explore the [shortcode list]({{< ref "docs/shortcodes" >}}) and [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">
Expand Down
7 changes: 7 additions & 0 deletions exampleSite/content/docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ Blowfish is a highly customisable theme and uses some of the latest Hugo feature

The theme ships with a default configuration that gets you up and running with a basic blog or static website.

{{< alert "fire" >}}
We just launched a CLI tool to help you get started with Blowfish. It will help you with installation and configuration. Install the CLI tool globally using:
```bash
npx blowfish-tools
```
{{< /alert >}}

> Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish.
The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.
Expand Down
9 changes: 9 additions & 0 deletions exampleSite/content/docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ series_order: 3
This section assumes you have already [installed the Blowfish theme]({{< ref "docs/installation" >}}).
{{< /alert >}}

</br>
{{< alert "fire" >}}
We just launched a CLI tool to help you get started with Blowfish. It will help you with installation and configuration. Install the CLI tool globally using:
```bash
npx blowfish-tools
```
{{< /alert >}}


The config files that ship with Blowfish contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.

## Basic configuration
Expand Down
11 changes: 10 additions & 1 deletion exampleSite/content/docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,16 @@ 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).

### Install with Blowfish Tools (Beta)
### Blowfish Tools (recommended)

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
npx blowfish-tools
```
or

```shell
npm i -g blowfish-tools
```
Expand All @@ -46,6 +51,10 @@ You can also run the command `blowfish-tools new` to create a new Hugo project a
blowfish-tools new mynewsite
```

Here's a quick video of how fast it is to get started with Blowfish using the CLI tool:

<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

#### Create a new site
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions exampleSite/content/users/datatodroids.tech/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "datatodroids.tech"
tags: [Personal site,Blog]
externalUrl: "https://datatodroids.tech/"
date: 9924-08-08
showDate: false
showAuthor: false
showReadingTime: false
showEdit: false
showLikes: false
showViews: false
layoutBackgroundHeaderSpace: false
---
Expand Down
10 changes: 9 additions & 1 deletion exampleSite/content/users/users.json
Original file line number Diff line number Diff line change
Expand Up @@ -528,5 +528,13 @@
"Personal site",
"Blog"
]
},
{
"title": "datatodroids.tech",
"url": "https://datatodroids.tech/",
"tags": [
"Personal site",
"Blog"
]
}
]
]
20 changes: 10 additions & 10 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hugo-blowfish-theme",
"version": "2.50.0",
"version": "2.51.0",
"description": "Blowfish theme for Hugo",
"scripts": {
"postinstall": "vendor-copy",
Expand Down Expand Up @@ -40,14 +40,14 @@
"jquery": "^3.7.1",
"katex": "^0.16.9",
"packery": "^2.1.2",
"prettier": "^3.1.1",
"prettier": "^3.2.3",
"prettier-plugin-go-template": "^0.0.15",
"prettier-plugin-tailwindcss": "^0.5.11",
"puppeteer": "^21.7.0",
"rimraf": "^5.0.5",
"tailwindcss": "^3.4.1",
"tw-elements": "1.1.0",
"typeit": "^8.8.0",
"typeit": "^8.8.3",
"vendor-copy": "^3.0.1"
},
"vendorCopy": [],
Expand Down

0 comments on commit 0a9b4a2

Please sign in to comment.