mirror of
https://github.com/nunocoracao/blowfish.git
synced 2025-01-22 22:45:42 -06:00
added ja skeleton files
This commit is contained in:
Nuno Coração
parent
5d00985704
commit
e90caa7a7b
5 changed files with 502 additions and 1 deletions
|
|
@ -5,7 +5,7 @@
|
||||||
theme = "blowfish"
|
theme = "blowfish"
|
||||||
baseURL = "https://localhost:1313"
|
baseURL = "https://localhost:1313"
|
||||||
defaultContentLanguage = "en"
|
defaultContentLanguage = "en"
|
||||||
#disableLanguages = ['it', 'fr'] #to allow translation work requiring shipping to production
|
#disableLanguages = ['ja'] #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
|
# pluralizeListTitles = "true" # hugo function useful for non-english languages, find out more in https://gohugo.io/getting-started/configuration/#pluralizelisttitles
|
||||||
|
|
||||||
|
|
|
||||||
272
exampleSite/content/docs/getting-started/index.ja.md
Normal file
272
exampleSite/content/docs/getting-started/index.ja.md
Normal file
|
|
@ -0,0 +1,272 @@
|
||||||
|
---
|
||||||
|
title: "Getting Started"
|
||||||
|
date: 2020-08-15
|
||||||
|
draft: false
|
||||||
|
description: "All the front matter variables available in Blowfish."
|
||||||
|
slug: "getting-started"
|
||||||
|
tags: ["installation", "docs"]
|
||||||
|
series: ["Documentation"]
|
||||||
|
series_order: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
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
|
||||||
|
|
||||||
|
Before creating any content, there are a few things you should set for a new installation. Starting in the `config.toml` file, set the `baseURL` and `languageCode` parameters. The `languageCode` should be set to the main language that you will be using to author your content.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/config.toml
|
||||||
|
|
||||||
|
baseURL = "https://your_domain.com/"
|
||||||
|
languageCode = "en"
|
||||||
|
```
|
||||||
|
|
||||||
|
The next step is to configure the language settings. Although Blowfish supports multilingual setups, for now, just configure the main language.
|
||||||
|
|
||||||
|
Locate the `languages.en.toml` file in the config folder. If your main language is English you can use this file as is. Otherwise, rename it so that it includes the correct language code in the filename. For example, for French, rename the file to `languages.fr.toml`.
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
Note that the language code in the language config filename should match the `languageCode` setting in `config.toml`.
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/languages.en.toml
|
||||||
|
|
||||||
|
title = "My awesome website"
|
||||||
|
|
||||||
|
[author]
|
||||||
|
name = "My name"
|
||||||
|
image = "img/author.jpg"
|
||||||
|
headline = "A generally awesome human"
|
||||||
|
bio = "A little bit about me"
|
||||||
|
links = [
|
||||||
|
{ twitter = "https://twitter.com/username" }
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
The `[author]` configuration determines how the author information is displayed on the website. The image should be placed in the site's `assets/` folder. Links will be displayed in the order they are listed.
|
||||||
|
|
||||||
|
If you need extra detail, further information about each of these configuration options, is covered in the [Configuration]({{< ref "configuration" >}}) section.
|
||||||
|
|
||||||
|
## Colour schemes
|
||||||
|
|
||||||
|
Blowfish ships with a number of colour schemes out of the box. To change the scheme, simply set the `colorScheme` theme parameter. Valid options are `blowfish` (default), `avocado`, `fire`, `ocean`, `forest`, `princess`, `neon`, `bloody`, `terminal`, `marvel`, `noir`, `autumn`, `congo`, and`slate`.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/params.toml
|
||||||
|
|
||||||
|
colorScheme = "blowfish"
|
||||||
|
```
|
||||||
|
|
||||||
|
Blowfish defines a three-colour palette that is used throughout the theme. Each main colour contains ten shades which are based upon the colours that are included in [Tailwind](https://tailwindcss.com/docs/customizing-colors#color-palette-reference). The three main colours are used for the header, footer, and accent colours. Here are the colors for each scheme:
|
||||||
|
|
||||||
|
#### Blowfish (default)
|
||||||
|
{{< swatches "#64748b" "#3b82f6" "#06b6d4" >}}
|
||||||
|
|
||||||
|
#### Avocado
|
||||||
|
{{< swatches "#78716c" "#84cc16" "#10b981" >}}
|
||||||
|
|
||||||
|
#### Fire
|
||||||
|
{{< swatches "#78716c" "#f97316" "#f43f5e" >}}
|
||||||
|
|
||||||
|
#### Ocean
|
||||||
|
{{< swatches "#64748b" "#3b82f6" "#06b6d4" >}}
|
||||||
|
|
||||||
|
#### Forest
|
||||||
|
{{< swatches "#658c86" "#3bf5df" "#06d45c" >}}
|
||||||
|
|
||||||
|
#### Princess
|
||||||
|
{{< swatches "#8c658c" "#f53bf2" "#7706d4" >}}
|
||||||
|
|
||||||
|
#### Neon
|
||||||
|
{{< swatches "#8338ec" "#ff006e" "#3a86ff" >}}
|
||||||
|
|
||||||
|
#### Bloody
|
||||||
|
{{< swatches "#d90429" "#8d99ae" "#457b9d" >}}
|
||||||
|
|
||||||
|
#### Terminal
|
||||||
|
{{< swatches "#004b23" "#38b000" "#1a759f" >}}
|
||||||
|
|
||||||
|
#### Marvel
|
||||||
|
{{< swatches "#2541b2" "#d81159" "#ffbc42" >}}
|
||||||
|
|
||||||
|
#### Noir
|
||||||
|
{{< swatches "#5c6b73" "#9db4c0" "#00a5cf" >}}
|
||||||
|
|
||||||
|
#### Autumn
|
||||||
|
{{< swatches "#0a9396" "#ee9b00" "#bb3e03" >}}
|
||||||
|
|
||||||
|
#### Congo
|
||||||
|
{{< swatches "#71717a" "#8b5cf6" "#d946ef" >}}
|
||||||
|
|
||||||
|
#### Slate
|
||||||
|
{{< swatches "#6B7280" "#64748b" "#6B7280" >}}
|
||||||
|
|
||||||
|
|
||||||
|
Although these are the default schemes, you can also create your own. Refer to the [Advanced Customisation]({{< ref "advanced-customisation#colour-schemes" >}}) section for details.
|
||||||
|
|
||||||
|
## Organising content
|
||||||
|
|
||||||
|
By default, Blowfish doesn't force you to use a particular content type. In doing so you are free to define your content as you wish. You might prefer _pages_ for a static site, _posts_ for a blog, or _projects_ for a portfolio.
|
||||||
|
|
||||||
|
Here's a quick overview of a basic Blowfish project. All content is placed within the `content` folder:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
.
|
||||||
|
├── assets
|
||||||
|
│ └── img
|
||||||
|
│ └── author.jpg
|
||||||
|
├── config
|
||||||
|
│ └── _default
|
||||||
|
├── content
|
||||||
|
│ ├── _index.md
|
||||||
|
│ ├── about.md
|
||||||
|
│ └── posts
|
||||||
|
│ ├── _index.md
|
||||||
|
│ ├── first-post.md
|
||||||
|
│ └── another-post
|
||||||
|
│ ├── aardvark.jpg
|
||||||
|
│ └── index.md
|
||||||
|
└── themes
|
||||||
|
└── blowfish
|
||||||
|
```
|
||||||
|
|
||||||
|
It's important to have a firm grasp of how Hugo expects content to be organised as the theme is designed to take full advantage of Hugo page bundles. Be sure to read the [official Hugo docs](https://gohugo.io/content-management/organization/) for more information.
|
||||||
|
|
||||||
|
Blowfish is also flexible when it comes to taxonomies. Some people prefer to use _tags_ and _categories_ to group their content, others prefer to use _topics_.
|
||||||
|
|
||||||
|
Hugo defaults to using posts, tags and categories out of the box and this will work fine if that's what you want. If you wish to customise this, however, you can do so by creating a `taxonomies.toml` configuration file:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/taxonomies.toml
|
||||||
|
|
||||||
|
topic = "topics"
|
||||||
|
```
|
||||||
|
|
||||||
|
This will replace the default _tags_ and _categories_ with _topics_. Refer to the [Hugo Taxonomy docs](https://gohugo.io/content-management/taxonomies/) for more information on naming taxonomies.
|
||||||
|
|
||||||
|
When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the correct sections, which is covered below.
|
||||||
|
|
||||||
|
## Menus
|
||||||
|
|
||||||
|
Blowfish has two menus that can be customised to suit the content and layout of your site. The `main` menu appears in the site header and the `footer` menu appears at the bottom of the page just above the copyright notice.
|
||||||
|
|
||||||
|
Both menus are configured in the `menus.en.toml` file. Similarly to the languages config file, if you wish to use another language, rename this file and replace `en` with the language code you wish to use.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/menus.toml
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "Blog"
|
||||||
|
pageRef = "posts"
|
||||||
|
weight = 10
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "Topics"
|
||||||
|
pageRef = "topics"
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
pre = "github"
|
||||||
|
name = "GitHub"
|
||||||
|
url = "https://github.com/nunocoracao/blowfish"
|
||||||
|
weight = 30
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
identifier = "github2"
|
||||||
|
pre = "github"
|
||||||
|
url = "https://github.com/nunocoracao/blowfish"
|
||||||
|
weight = 40
|
||||||
|
|
||||||
|
[[footer]]
|
||||||
|
name = "Privacy"
|
||||||
|
url = "https://external-link"
|
||||||
|
```
|
||||||
|
|
||||||
|
The `name` parameter specifies the text that is used in the menu link. You can also optionally provide a `title` which fills the HTML title attribute for the link.
|
||||||
|
|
||||||
|
The `pageRef` parameter allows you to easily reference Hugo content pages and taxonomies. It is the quickest way to configure the menu as you can simply refer to any Hugo content item and it will automatically build the correct link. To link to external URLs, the `url` parameter can be used.
|
||||||
|
|
||||||
|
The `pre` parameter allows you to place an icon from [Blowfish's icon set]({{< ref "samples/icons" >}}) on the menu entry. This parameter can be used with `name` parameter or by itself. If you want to use multiple menu entries with just icons please set the `identifier`parameter otherwise Hugo will default to the naming tag as the id and probably not display all the menu entries.
|
||||||
|
|
||||||
|
Menu links will be sorted from lowest to highest `weight`, and then alphabetically by `name`.
|
||||||
|
|
||||||
|
Both menus are completely optional and can be commented out if not required. Use the template provided in the file as a guide.
|
||||||
|
|
||||||
|
### Nested menus
|
||||||
|
|
||||||
|
The theme also supports nested menus. In order to use them you just need to define a parent entry in `menu.toml` and its sub-menus using the `parent` parameter to reference the parent. All properties can be used for sub-menus. `pageRef` and `url` can also be used in the parent entry. Nested menus are only available in the main menu not for the footer.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/menus.toml
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "Parent"
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "sub-menu 1"
|
||||||
|
parent = "Parent"
|
||||||
|
pageRef = "samples"
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "sub-menu 2"
|
||||||
|
parent = "Parent"
|
||||||
|
pageRef = "samples"
|
||||||
|
weight = 20
|
||||||
|
|
||||||
|
[[main]]
|
||||||
|
name = "sub-menu 3"
|
||||||
|
parent = "Parent"
|
||||||
|
pre = "github"
|
||||||
|
pageRef = "samples"
|
||||||
|
weight = 20
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sub-Navigation menu
|
||||||
|
|
||||||
|
Additionally, you can also configure a sub-navigation menu. Just define new menu entries as `subnavigation` in `menus.toml`.
|
||||||
|
This will render a second line with sub-categories below the main header menu.
|
||||||
|
|
||||||
|
```toml
|
||||||
|
# config/_default/menus.toml
|
||||||
|
|
||||||
|
[[subnavigation]]
|
||||||
|
name = "An interesting topic"
|
||||||
|
pageRef = "tags/interesting-topic"
|
||||||
|
weight = 10
|
||||||
|
|
||||||
|
[[subnavigation]]
|
||||||
|
name = "My Awesome Category"
|
||||||
|
pageRef = "categories/awesome"
|
||||||
|
weight = 20
|
||||||
|
```
|
||||||
|
|
||||||
|
The default `name` is the `pageRef` title cased.
|
||||||
|
|
||||||
|
## Thumbnails & Backgrounds
|
||||||
|
|
||||||
|
Blowfish was built so it would be easy to add visual support to your articles. If your familiar with Hugo article structure, you just need to place an image file (almost all formats are supported but we recommend `.png` or `.jpg`) that starts with `feature*` inside your article folder. And that's it, Blowfish will then be able to both use the image as a thumbnail within your website as well as for <a target="_blank" href="https://oembed.com/">oEmbed</a> cards across social platforms.
|
||||||
|
|
||||||
|
[Here]({{< ref "thumbnails" >}}) is also a guide with more info and a [sample]({{< ref "thumbnail_sample" >}}) if you want to see how you can do it.
|
||||||
|
|
||||||
|
Additionally, Blowfish also supports background hero images in articles and lists. In order to use a different image than the featured one, add an image file in which the name starts with `background*`.
|
||||||
|
|
||||||
|
## Detailed configuration
|
||||||
|
|
||||||
|
The steps above are the bare minimum configuration. If you now run `hugo server` you will be presented with a blank Blowfish website. Detailed configuration is covered in the [Configuration]({{< ref "configuration" >}}) section.
|
||||||
210
exampleSite/content/docs/installation/index.ja.md
Normal file
210
exampleSite/content/docs/installation/index.ja.md
Normal file
|
|
@ -0,0 +1,210 @@
|
||||||
|
---
|
||||||
|
title: "Installation"
|
||||||
|
date: 2020-08-16
|
||||||
|
draft: false
|
||||||
|
description: "How to install the Blowfish theme."
|
||||||
|
slug: "installation"
|
||||||
|
tags: ["installation", "docs"]
|
||||||
|
series: ["Documentation"]
|
||||||
|
series_order: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
Simply follow the standard Hugo [Quick Start](https://gohugo.io/getting-started/quick-start/) procedure to get up and running quickly.
|
||||||
|
|
||||||
|
Detailed installation instructions can be found below. Instructions for [updating the theme](#installing-updates) are also available.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
These instructions will get you up and running using Hugo and Blowfish from a completely blank state. Most of the dependencies mentioned in this guide can be installed using the package manager of choice for your platform.
|
||||||
|
|
||||||
|
### Install Hugo
|
||||||
|
|
||||||
|
If you haven't used Hugo before, you will need to [install it onto your local machine](https://gohugo.io/getting-started/installing). You can check if it's already installed by running the command `hugo version`.
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
Make sure you are using **Hugo version 0.87.0** or later as the theme takes advantage of some of the latest Hugo features.
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
You can find detailed installation instructions for your platform in the [Hugo docs](https://gohugo.io/getting-started/installing).
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
There several different ways to install the Blowfish theme into your Hugo website. From easiest to most difficult to install and maintain, they are:
|
||||||
|
|
||||||
|
- [Git submodule](#install-using-git) (recommended)
|
||||||
|
- [Hugo module](#install-using-hugo)
|
||||||
|
- [Manual file copy](#install-manually)
|
||||||
|
|
||||||
|
If you're unsure, choose the Git submodule method.
|
||||||
|
|
||||||
|
##### 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.
|
||||||
|
|
||||||
|
Change into the directory for your Hugo website (that you created above), initialise a new `git` repository and add Blowfish as a submodule.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd mywebsite
|
||||||
|
git init
|
||||||
|
git submodule add -b main https://github.com/nunocoracao/blowfish.git themes/blowfish
|
||||||
|
```
|
||||||
|
|
||||||
|
Then continue to [set up the theme configuration files](#set-up-theme-configuration-files).
|
||||||
|
|
||||||
|
##### 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.
|
||||||
|
|
||||||
|
1. [Download](https://golang.org/dl/) and install Go. You can check if it's already installed by using the command `go version`.
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
Make sure you are using **Go version 1.12** or later as Hugo requires this for modules to work correctly.
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
2. From your Hugo project directory (that you created above), initialise modules for your website:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# If you're managing your project on GitHub
|
||||||
|
hugo mod init github.com/<username>/<repo-name>
|
||||||
|
|
||||||
|
# If you're managing your project locally
|
||||||
|
hugo mod init my-project
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Add the theme to your configuration by creating a new file `config/_default/module.toml` and adding the following:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[[imports]]
|
||||||
|
path = "github.com/nunocoracao/blowfish/v2"
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
1. Download the latest release of the theme source code.
|
||||||
|
|
||||||
|
{{< button href="https://github.com/nunocoracao/blowfish/releases/latest" target="_blank" >}}Download from Github{{< /button >}}
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
**Note:** You should not overwrite the `module.toml` file if one already exists in your project!
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
Depending on how you installed the theme you will find the theme config files in different places:
|
||||||
|
|
||||||
|
- **Hugo Modules:** In the Hugo cache directory, or [download a copy](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/nunocoracao/blowfish/tree/main/config/_default) from GitHub
|
||||||
|
- **Git submodule or Manual install:** `themes/blowfish/config/_default`
|
||||||
|
|
||||||
|
Once you've copied the files, your config folder should look like this:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
config/_default/
|
||||||
|
├─ config.toml
|
||||||
|
├─ languages.en.toml
|
||||||
|
├─ markup.toml
|
||||||
|
├─ menus.en.toml
|
||||||
|
├─ module.toml # if you installed using Hugo Modules
|
||||||
|
└─ params.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< 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.
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
### Next steps
|
||||||
|
|
||||||
|
The basic Blowfish installation is now complete. Continue to the [Getting Started]({{< ref "getting-started" >}}) section to learn more about configuring the theme.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installing updates
|
||||||
|
|
||||||
|
From time to time there will be [new releases](https://github.com/nunocoracao/blowfish/releases) posted that apply fixes and add new functionality to the theme. In order to take advantage of these changes, you will need to update the theme files on your website.
|
||||||
|
|
||||||
|
How you go about this will depend on the installation method you chose when the theme was originally installed. Instructions for each method can be found below.
|
||||||
|
|
||||||
|
- [Git submodule](#update-using-git)
|
||||||
|
- [Hugo module](#update-using-hugo)
|
||||||
|
- [Manual file copy](#update-manually)
|
||||||
|
|
||||||
|
### Update using git
|
||||||
|
|
||||||
|
Git submodules can be updated using the `git` command. Simply execute the following command and the latest version of the theme will be downloaded into your local repository:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
git submodule update --remote --merge
|
||||||
|
```
|
||||||
|
|
||||||
|
Once the submodule has been updated, rebuild your site and check everything works as expected.
|
||||||
|
|
||||||
|
### Update using Hugo
|
||||||
|
|
||||||
|
Hugo makes updating modules super easy. Simply change into your project directory and execute the following command:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
hugo mod get -u
|
||||||
|
```
|
||||||
|
|
||||||
|
Hugo will automatically update any modules that are required for your project. It does this by inspecting your `module.toml` and `go.mod` files. If you have any issues with the update, check to ensure these files are still configured correctly.
|
||||||
|
|
||||||
|
Then simply rebuild your site and check everything works as expected.
|
||||||
|
|
||||||
|
### Update manually
|
||||||
|
|
||||||
|
Updating Blowfish manually requires you to download the latest copy of the theme and replace the old version in your project.
|
||||||
|
|
||||||
|
{{< alert >}}
|
||||||
|
Note that any local customisations you have made to the theme files will be lost during this process.
|
||||||
|
{{< /alert >}}
|
||||||
|
|
||||||
|
1. Download the latest release of the theme source code.
|
||||||
|
|
||||||
|
{{< button href="https://github.com/nunocoracao/blowfish/releases/latest" target="_blank" >}}Download from Github{{< /button >}}
|
||||||
|
|
||||||
|
2. Extract the archive, rename the folder to `blowfish` and move it to the `themes/` directory inside your Hugo project's root folder. You will need to overwrite the existing directory to replace all the theme files.
|
||||||
|
|
||||||
|
3. Rebuild your site and check everything works as expected.
|
||||||
19
exampleSite/content/samples/_index.ja.md
Executable file
19
exampleSite/content/samples/_index.ja.md
Executable file
|
|
@ -0,0 +1,19 @@
|
||||||
|
---
|
||||||
|
title: "Samples"
|
||||||
|
description: "See what's possible with Blowfish."
|
||||||
|
|
||||||
|
cascade:
|
||||||
|
showEdit: false
|
||||||
|
showSummary: false
|
||||||
|
hideFeatureImage: true
|
||||||
|
---
|
||||||
|
|
||||||
|
{{< lead >}}
|
||||||
|
Blowfish brings your content to life. :heart_eyes:
|
||||||
|
{{< /lead >}}
|
||||||
|
|
||||||
|
This section contains some demo pages that show how Blowfish renders different types of content. You can also see an example [taxonomy listing]({{< ref "tags" >}}) page.
|
||||||
|
|
||||||
|
_**Sidenote:** This page is just a standard Blowfish article listing and Hugo has been configured to generate a `samples` content type and display article summaries._
|
||||||
|
|
||||||
|
---
|
||||||
Loading…
Reference in a new issue