An open API service indexing awesome lists of open source software.

https://github.com/pome-ta/pome-ta_hugo-blog


https://github.com/pome-ta/pome-ta_hugo-blog

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

![top](./readme_resource/top.png)
HUGOを使ったブログを簡単に作成するためのテンプレートです

## forkするだけでできること

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

## セットアップ

### HUGOの設定

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

#### Baseurl

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

#### ブログのタイトル

``` .toml
title = "hugo-blog-template"
```

#### 自己紹介

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

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

#### ページのテーマカラー

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

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

#### SNS等のユーザー名

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

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

### GitHub Pagesの設定

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

#### ページの公開

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