↓ Skip to main content
Chinese AI Application Development Association
Background Image

Getting Started

Table of Contents
This section assumes you have already read Installing Blowfish Theme.

We’ve just released a CLI tool to help you get started with Blowfish quickly. It will help you install and configure the Blowfish theme. You can install the CLI tool globally using the following command:

npx blowfish-tools

The configuration files in Blowfish contain all possible setting options that the theme needs. However, by default, most settings are commented out, and you only need to uncomment them to activate or modify the setting options.

Basic Setup
#

After installation and before creating content, there are several settings that need attention. Starting with hugo.toml, set the baseURL and languageCode parameters. The languageCode parameter is used to specify the primary language for your content creation.

# config/_default/hugo.toml

baseURL = "https://your_domain.com/"
languageCode = "en"

The next step is to set up the language. Although Blowfish supports multiple languages, hugo.toml can only configure one primary language.

Find languages.en.toml in the config/_default folder. If your primary language is English, you can use this file directly. Otherwise, you need to rename it to the corresponding filename for your primary language. For example, if the primary language is French, you need to name the file languages.fr.toml.

Note: The language code in the language configuration filename must match the languageCode in hugo.toml.
# config/_default/languages.en.toml

title = "My awesome website"

Site Configuration
#

After setting up the basic language configuration, you’ll need to configure your site’s basic information:

Site Title and Description
#

Set your site’s title and description in the language configuration file:

# config/_default/languages.en.toml

title = "My Website"
description = "A brief description of your website"

Author Information
#

Configure author information for your site:

# config/_default/languages.en.toml

[author]
  name = "Your Name"
  image = "img/author.jpg"
  headline = "Your headline or tagline"
  bio = "A brief bio about yourself"
  links = [
    { email = "mailto:hello@your_domain.com" },
    { github = "https://github.com/username" },
    { twitter = "https://twitter.com/username" }
  ]

Menu Configuration#

Configure your site’s navigation menus by editing the menu configuration file:

# config/_default/menus.en.toml

[[main]]
  name = "Blog"
  pageRef = "posts"
  weight = 10

[[main]]
  name = "About"
  pageRef = "about"
  weight = 20

[[main]]
  name = "Contact"
  pageRef = "contact"
  weight = 30

Theme Parameters
#

Customize the theme’s appearance and behavior through the parameters configuration:

# config/_default/params.toml

colorScheme = "blowfish"
defaultAppearance = "light"
autoSwitchAppearance = true

[homepage]
  layout = "page"
  homepageImage = "img/homepage.jpg"
  showRecent = true
  showRecentItems = 5

Creating Content
#

Once your basic configuration is complete, you can start creating content:

Creating Your First Post
#

hugo new posts/my-first-post.md

Creating Pages
#

hugo new about.md
hugo new contact.md

Testing Your Site
#

Run the Hugo development server to test your site:

hugo server

Your site will be available at http://localhost:1313.

Next Steps
#

No articles published here yet.