設定

はじめに

Hugoの設定ファイルのうち、主に私が設定した内容を紹介します。詳細は本家サイトをご覧ください。

ファイル

Hugoの設定ファイルは、config.tomlか、config.yaml、config.jsonのどれかです。自分の使いやすいファイル形式を利用することができます。私は、TOML形式の、config.tomlを利用しています。

設定内容

以下のような設定を行いました(全てではありませんが)。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

baseURL = "https://garretlab.web.fc2.com"
defaultContentLanguage = "ja"
hasCJKLanguage = true
title = "garretlab"
theme = "garretlab"
disableKinds = ["RSS"]
pygmentsUseClasses = true
disablePathToLower = true
enableGitInfo = true
enableRobotsTXT = true

設定項目

設定項目の意味は以下の通りです。

項目 意味 デフォルト値
archetypeDir archetype(コンテンツのテンプレート)を配置するディレクトリ。 “archetypes”
assetDir Hugo Pipesで使われるディレクトリ。 “assets”
baseURL URLのルート。
buildDrafts ドラフトコンテンツを含めるか。 false
buildExpired 期限切れコンテンツを含めるか。 false
buildFuture 公開予定前のコンテンツを含めるか。 false
canonifyURLs 相対URLを絶対URLに変換するか。 false
contentDir コンテンツファイルを配置するディレクトリ。 “content”
dataDir データを配置するディレクトリ。 “data”
defaultContentLanguage デフォルトの言語。 “en”
defaultContentLanguageInSubdir デフォルト言語のコンテンツをサブディレクトリに作成するか。 false
disableAliases 別名(alias)へのリダイレクトを行わないか。 false
disableHugoGeneratorInject generator メタタグを生成しないか。 false
disableKinds 指定した種別のコンテンツを禁止する。 []
disableLiveReload サーバモードで実行時に、自動リロードを行わないか。 false
disablePathToLower URLを小文字にしないか。 false
enableEmoji 絵文字を有効にするか。 false
enableGitInfo .GitInfo を各ページに設定する。ファイルのLastmod(最終変更日時)に、Gitへのコミット日時を利用する。 false
enableInlineShortcodes インラインショートコードを有効にするか。 false
enableMissingTranslationPlaceholders 翻訳できなかったときに、デフォルト値ではなくプレースホルダを表示するか。 false
enableRobotsTXT robots.txtを生成するか。 false
footnoteAnchorPrefix footnoteアンカーの接頭語。 ""
footnoteReturnLinkContents footnoteからリターンする際に表示するテキスト。 ""
googleAnalytics Google AnalyticsのトラッキングID。 ""
hasCJKLanguage コンテンツ内の、中国語、日本語、韓国語の自動判定。 false
languageCode サイトの言語コード。 ""
languageName サイトの言語名。 ""
layoutDir レイアウト(テンプレート)を配置するディレクトリ。 “layouts”
log ロギングを有効にするか。 false
logFile ログファイル名。 ""
newContentEditor 新規コンテンツを編集する際のエディタ。 ""
noChmod ファイルのパーミッションを同期しない。 false
noTimes ファイルの修正時刻を同期しない。 false
Pagenate ページネーションでの、1ページあたりの要素数。 10
paginatePath ページネーションで利用されるパス名。 “page”
pluralizeListTitles リストのタイトルを複数形にする。 true
publishDir HTMLファイルを出力するディレクトリ。 “public”
relativeURLs 全ての相対パスを、コンテントルートからの相対パスにする。 false
refLinksErrorLevel refもしくはrelrefを使ってリンクを解決できなかったときのログレベル。 “ERROR”
refLinksNotFoundURL refもしくはrelrefを使ってリンクを解決できなかったときにプレースホルダとして使われるURL。
rssLimit RSSフィードの最大アイテム数。 unlimited
sectionPagesMenu セクションページ用のメニュー名。 ""
staticDir 静的コンテンツを配置するディレクトリ。 “static”
summaryLength .Summaryで表示するサマリの語数。 70
taxonomies 記事分類関連の設定。 category = “categories”
tag = “tags”
theme 利用するテーマ名。 ""
themesDir テーマを配置するディレクトリ。 “themes”
timeout ページコンテンツを生成する際のタイムアウト。単位はミリ秒。 10000
title サイトのタイトル。 ""
titleCaseStyle タイトルで利用されるスタイル。 “AP”
uglyURLs 有効にすると、/filename/ ではなく /filename.html 形式のURLを生成する。 false
verbose verbose出力を有効にする。 false
verboseLog verboseログ出力を有効にする。 false
watch ファイルシステムの変更を監視して必要に応じてコンテンツを再生成する。 false

最低限、baseURLとthemeがあれば、動作はすると思います。

最終更新日

February 7, 2021

inserted by FC2 system