【備忘録】Config.tomlの項目
あらすじ
Hugoでコンフィグファイルとして用意されているConfig.tomlですが、
イマイチ頭に入らなくて忘れやすい項目があったりするので、
備忘録としてまとめることにしました。
新しく知った項目があれば、ここに書き足していきたいと思います。
Config.tomlの内容
とりあえず今使っているconfig.tomlを一覧化
baseURL = "https://takaken.tokyo/"
title = "たかけんテックラボ"
author = "たかけん"
theme = "hugo_theme_robust"
summarylength = 50
HasCJKLanguage = true
DefaultContentLanguage = "ja"
languageCode = "ja-jp"
disqusShortname = "XXXXXYYYYYZZZZZ"
copyright = "Copyright © 2019 takaken"
googleAnalytics = "UA-XXXXXXXXX-9"
enableRobotsTXT = true
paginate = 20
[Params]
description = "Everything happens for a reason."
dateformat = "2006/01/02"
[taxonomies]
tag = "tags"
category = "categories"
archive = "archives"
[markup.goldmark.renderer]
unsafe = true
[blackfriday]
hrefTargetBlank = true
説明
baseURL
サイトのベースとなる公開用URLを記載する項目。
DefaultContentLanguage
Hugoは多言語対応しているが、
多言語対応サイトを作成した際に、
どの言語がデフォルトなのかを設定する項目。
多言語対応サイトはあまり使わないから使用頻度は低め。
languageCode
RSS出力などの際に付与する文字コードだったり、
多言語対応サイトにする場合に使用する。
日本語サイトなら"Ja-jp"や"ja"と設定しておいた方がよい。
title
サイトのタイトル名を設定する。
author
サイトの運営者名を設定する。
theme
Hugoで使っているテーマを設定する。
フォルダ名を設定することになる。
summarylength
サイトのトップ画面を開いた時に記事のタイトル下に
要約として表示される文字のカウントを指定することができる。
HasCJKLanguage
上記のsummarylengthを使う時、
日本語で記事を書くと２バイト文字を適切にハンドリングできずに
表示が意図しない状態になる。
そのため、C(中国語) J(日本語) K(韓国語)を使う場合は
この項目をTrueにする必要がある。
disqusShortname
HugoにはWordPressのコメント機能のようなものは装備されていない。
しかし、Disqusというコメントサービスなどと連携することで
コメント機能を実装することができる。
この項目にDisqusで登録したコードを設定すると反映される。
ただしlocalhost上では反映されず、ネットで公開された時に反映されるため注意。
copyright
記載することでフッター部に著作権表示をすることができる。
googleAnalytics
Google Analyticsと連携する際にここにコードを設定することで
Analyticsにデータを飛ばすことが可能となる。
enableRobotsTXT
robots.txt を機能させるようにするための項目。
デフォルトではFalseになっているため使う場合はTrueにする必要がある。
paginate
１ページに表示する記事数を変更することができる。
デフォルトでは10記事分表示だが、
paginate = 20 とすると１ページにつき20記事分表示する。
[Params]
以下の項目は[Params]と記載された以下に記載することで設定が適用される。
「Params」より下に書かないと反映されないので注意が必要（たまにやりがち）
description
タイトルの下に表示されるテキスト文。
dateformat
サイトの日付表示を指定する。
デフォルトではJan 2nd 2006 のようになっているが、
"2006/01/02" と記載することで yyyy/MM/dd 表記にすることができる。
[taxonomies]
タグ、カテゴリー、アーカイブなどを設定する項目。
tag
タグを使う場合はtag = "tags" と記載する。
category
カテゴリーを使う場合は category = "categories" と記載する。
archive
アーカイブを使う場合はarchive = "archives" と記載する。
[markup.goldmark.renderer]
unsafe
Markdown形式で記事を書く時はHTML形式の記述は無視されて
テキストベースで表示される。
ちょっとしたインパクトを与えたくてHTML形式を反映させたい場合は、
この項目を true にすることで反映される。
[Blackfriday]
hrefTargetBlank
リンクを新しいタブで開くようにしてくれる項目。
Go言語で作成されているライブラリ。
上記のリンクを新しいタブでやる方法はHugoの0.60～0.62までのやり方でした。
0.62以降については下記のやり方で別タブ表示します。
以上