top HUGOを使ったブログを簡単に作成するためのテンプレートです

MORE INFO (Zenn)

forkするだけでできること

  • GitHub Actionsによる自動デプロイ
  • GitHub Pagesに公開

セットアップ

HUGOの設定

config.tomlを編集してhugoの設定をします
$ hugo serveを実行してページのプレビューを確認できます

Baseurl

baseURL = "https://{Github ユーザー名}.github.io/{forkしたリポジトリ名}"

ブログのタイトル

title = "hugo-blog-template"

自己紹介

[Author]
    name = "Author"
    bio = "ここに自己紹介を入れることができます"
    avatar = "img/avatar.png"

アバターの画像はstatic/img/avatar.pngに配置しています

ページのテーマカラー

[Params.style.vars]
  highlightColor = "#e22d30"

#rrggbbの形式で指定してください

SNS等のユーザー名

[Params.widgets.social]
  twitter = "uvrub"
  github = "kato-k"

アカウントIDを指定するとサイドバーに表示されます

GitHub Pagesの設定

config.tomlの変更をリモートリポジトリに反映すると、GitHub Actionsによってページのビルドが走ります。
ビルド結果はgithub-actions[bot]によってgh-pagesブランチにコミットされます。

ページの公開

リポジトリのSettingsタブ→Pagesを開いてください。
publish 画像の四角で囲った部分をgh-pagesに変更し、saveをクリックすると公開が始まります。
アクセスできるようになるまで10分程度間があります。