blowfish/exampleSite/content/docs/configuration/index.ja.md
yuubinnkyoku de09f7a05f 📝 Update
2024-12-11 13:59:14 +00:00

52 KiB
Raw Blame History

title weight draft description slug tags series series_order
設定 4 false Blowfish で使用可能なすべての設定変数 configuration
config
docs
Documentation
4

Blowfish は高度にカスタマイズ可能なテーマであり、最新の Hugo 機能を使用して設定方法をシンプルにしています。

このテーマには、基本的なブログまたは静的 Web サイトをすぐに立ち上げて実行できるデフォルト設定が付属しています。

{{< alert "fire" >}} Blowfish を簡単に使い始められるように、新しい CLI ツールをリリースしました。インストールと設定に役立ちます。 グローバルに CLI ツールをインストールするには、以下を使用します。

npx blowfish-tools

{{< /alert >}}

テーマにバンドルされている設定ファイルは、デフォルトの Hugo 構文である TOML 形式で提供されています。必要に応じて、設定を YAML または JSON に変換できます。

デフォルトのテーマ設定は各ファイルに記載されているため、必要に応じて設定を自由に調整できます。

{{< alert >}} [インストール手順]({{< ref "/docs/installation#set-up-theme-configuration-files" >}}) で概説されているように、Hugo プロジェクトの config/_default/ フォルダ内のファイルを修正し、プロジェクトルートの config.toml ファイルを削除することで、テーマ設定を調整する必要があります。 {{< /alert >}}

サイト設定

テーマ全体で標準の Hugo 設定変数が適用されますが、最適なエクスペリエンスを得るために設定する必要がある特定の事項があります。

サイト設定は config/_default/config.toml ファイルで管理されます。 下の表は、Blowfish が活用するすべての設定の概要を示しています。

この表で提供されている変数名は、TOML データ構造を簡素化するためにドット表記を使用していることに注意してください(つまり、 outputs.home[outputs] home を指します)。

Name Default Description
theme "blowfish" Hugo Modules を使用している場合は、この設定値を削除する必要があります。 他のすべてのインストールタイプでは、テーマが機能するためにこれを blowfish に設定する必要があります。
baseURL 設定なし Webサイトのルートへの URL です。
defaultContentLanguage "en" この値は、テーマコンポーネントとコンテンツのデフォルト言語を決定します。 サポートされている言語コードについては、以下の 言語と i18n セクションを参照してください。
enableRobotsTXT true 有効にすると、検索エンジンがサイト全体をクロールできるようにする robots.txt ファイルがサイトルートに作成されます。 あらかじめ作成した独自の robots.txt を提供する場合は、false に設定し、ファイルを static ディレクトリに配置します。 完全に制御するには、このファイルを生成するための [カスタムレイアウト]({{< ref "content-examples#custom-layouts" >}}) を提供できます。
pagination.pagerSize 10 記事リストの各ページにリストされる記事の数です。
summaryLength 0 [フロントマター]({{< ref "front-matter" >}}) で提供されていない場合に、記事の概要を生成するために使用される単語の数です。 値 0 は最初の文を使用します。 概要が非表示になっている場合、この値は効果がありません。
outputs.home ["HTML", "RSS", "JSON"] サイト用に生成される出力形式です。 Blowfish では、すべてのテーマコンポーネントが正しく機能するために HTML、RSS、JSON が必要です。
permalinks 設定なし パーマリンクの設定については、Hugo ドキュメント を参照してください。
taxonomies 設定なし 分類の設定については、[コンテンツの整理]({{< ref "getting-started#organising-content" >}}) セクションを参照してください。

サムネイル

Blowfish は、記事に視覚的なサポートを簡単に追加できるように構築されています。Hugo の記事構造に慣れている場合は、記事フォルダ内に feature* で始まる画像ファイル(ほとんどすべての形式がサポートされていますが、.png または .jpg をお勧めしますを配置するだけです。これで、Blowfish は Webサイト内でサムネイルとして画像を使用したり、ソーシャルプラットフォーム全体で oEmbed カードに使用したりできます。

[Here]({{< ref "thumbnails" >}}) is also a guide with more info and a [sample]({{< ref "thumbnail_sample" >}}) if you want to see how you can do it.

言語と i18n

Blowfish は多言語 Webサイト向けに最適化されており、テーマアセットはすぐに使えるように複数の言語に翻訳されています。 言語設定を使用すると、コンテンツの複数のバージョンを生成して、訪問者に母国語でカスタマイズされたエクスペリエンスを提供できます。

このテーマは現在、デフォルトで次の言語をサポートしています:

言語 コード
アラビア語 ar
ブルガリア語 bg
ベンガル語 bn
カタロニア語 ca
チェコ語 cs
ドイツ語 de
英語 en
エスペラント語 eo
スペイン語(スペイン) es
フィンランド語 fi
フランス語 fr
ヘブライ語 he
クロアチア語 hr
ハンガリー語 hu
インドネシア語 id
イタリア語 it
日本語 ja
韓国語 ko
オランダ語 nl
ポーランド語 pl
ポルトガル語(ブラジル) pt-br
ポルトガル語(ポルトガル) pt-pt
ルーマニア語 ro
ロシア語 ru
トルコ語 tr
ベトナム語 vi
中国語(簡体字) zh-cn
中国語(繁体字) zh-tw

デフォルトの翻訳は、翻訳文字列を含むカスタムファイル i18n/[言語コード].yaml を作成することでオーバーライドできます。 この方法を使用して新しい言語を追加することもできます。 新しい翻訳をコミュニティと共有したい場合は、プルリクエストを開いて ください。

設定

可能な限り柔軟に対応するために、Web サイトの各言語の言語設定ファイルを作成する必要があります。デフォルトでは、Blowfish には config/_default/languages.en.toml に英語の言語設定が含まれています。

デフォルトのファイルは、追加の言語を作成するためのテンプレートとして使用することも、英語以外の言語で Web サイトを作成する場合は名前を変更することもできます。languages.[言語コード].toml 形式を使用してファイルに名前を付けるだけです。

{{< alert >}} 注: サイト設定defaultContentLanguage パラメータが、言語設定ファイル名の言語コードと一致していることを確認してください。 {{< /alert >}}

グローバル

名前 デフォルト 説明
languageCode "en" このファイルの Hugo 言語コードです。トップレベル言語(例: en)またはサブバリアント(例: en-auにすることができ、ファイル名の言語コードと一致する必要があります。Hugo はこの値が常に小文字であることを想定しています。適切な HTML 準拠のために、大文字と小文字を区別する isoCode パラメータを設定します。
languageName "English" 言語の名前です。
weight 1 重みは、多言語サイトを構築するときの言語の順序を決定します。
title "Blowfish" Web サイトのタイトルです。これは、サイトのヘッダーとフッターに表示されます。

パラメーター

名前 デフォルト 説明
params.displayName "EN" Web サイトに言語が表示されるときに使用される名前です。
params.isoCode "en" HTML メタデータ用の ISO 言語コードです。トップレベル言語(例: en)またはサブバリアント(例: en-AU)にすることができます。
params.rtl false これが RTL 言語かどうかです。true に設定すると、コンテンツが右から左に並べ替えられます。 Blowfish は RTL 言語と LTR 言語の同時使用を完全にサポートしており、両方に動的に調整されます。
params.dateFormat "2 January 2006" この言語での日付のフォーマット方法です。使用できる形式については、Hugo ドキュメント を参照してください。
params.logo 設定なし assets/ フォルダ内のサイトロゴファイルへの相対パスです。ロゴファイルは2倍の解像度で提供する必要があり、あらゆる画像サイズをサポートしています。
params.secondaryLogo 設定なし assets/ フォルダ内のセカンダリサイトロゴファイルへの相対パスです。 ロゴファイルは2倍の解像度で提供する必要があり、あらゆる画像サイズをサポートしています。 これは、logo とは反転/対照的なカラースキームである必要があります。設定されている場合、このロゴは、ユーザーが defaultAppearance モードから切り替えたときに表示されます。
params.description 設定なし Web サイトの説明です。これはサイトのメタデータで使用されます。
params.copyright 設定なし サイトフッターの著作権メッセージの Markdown 文字列には、プレースホルダ { year } を含めて現在の年を動的に挿入できます。指定されていない場合、Blowfish はサイト title を使用して著作権文字列を自動的に生成します。

著者(Author)

名前 デフォルト 説明
author.name 設定なし 著者の名前です。これは、記事のフッターと、プロフィールレイアウトが使用されている場合はホームページに表示されます。
author.image 設定なし 著者の画像ファイルへのパスです。画像は縦横比 1:1 である必要があります。画像は、サイトの assets/ フォルダに配置することも、外部 URL にすることもできます。
author.headline 設定なし 著者の見出しを含む Markdown 文字列です。プロフィールホームページの著者の名前に下に表示されます。
author.bio 設定なし 著者の略歴を含む Markdown 文字列です。記事のフッターに表示されます。
author.links 設定なし 著者の詳細と一緒に表示するリンクです。設定ファイルには、コメントを外すだけで有効になるリンクの例が含まれています。リンクが表示される順序は、配列に表示される順序によって決まります。assets/icons/ に対応する SVG アイコンアセットを提供することで、カスタムリンクを追加できます。

メニュー(Menus)

Blowfish は、言語固有のメニュー設定もサポートしています。メニュー設定ファイルは、言語ファイルと同じ命名形式に従います。ファイル名に言語コードを指定するだけで、Hugo はファイルがどの言語に関連しているかを認識します。

メニュー設定ファイルの名前は、 menus.[language-code].toml 形式です。メニュー設定で使用される言語コードが言語設定と一致していることを常に確認してください。

[はじめに]({{< ref "getting-started#menus" >}}) セクションでは、このファイルの構造について詳しく説明しています。詳細な設定例については、Hugo メニュー ドキュメント も参照できます。

テーマパラメーター(Theme parameters)

Blowfish は、テーマの機能を制御する多数の設定パラメータを提供します。下の表は、config/_default/params.toml ファイルで使用可能なすべてのパラメータの概要を示しています。

ここにある記事のデフォルトの多くは、フロントマターで指定することで、記事ごとにオーバーライドできます。詳細については、[フロントマター]({{< ref "front-matter" >}}) セクションを参照してください。

グローバル

名前 デフォルト 説明
colorScheme "blowfish" 使用するテーマのカラーテーマです。有効な値は、blowfish(デフォルト)、avocadofireoceanforestprincessneonbloodyterminalmarvelnoirautumncongoslate です。詳細については、[カラーテーマ]({{< ref "getting-started#colour-schemes" >}}) セクションを参照してください。
defaultAppearance "light" デフォルトのテーマの外観です。light または dark のいずれかです。
autoSwitchAppearance true 訪問者のオペレーティングシステムの設定に基づいてテーマの外観を自動的に切り替えるかどうかです。false に設定すると、サイトは常に defaultAppearance を使用します。
enableSearch false サイト内検索が有効かどうかです。true に設定すると、検索機能が有効になります。検索機能は、サイト設定outputs.home 設定が正しく設定されているかどうかに依存することに注意してください。
enableCodeCopy false <code> ブロックのクリップボードへのコピーボタンを有効にするかどうかです。コードコピーが正しく機能するには、highlight.noClasses パラメータを false に設定する必要があります。以下の その他の設定ファイル について読んでください。
mainSections 設定なし 最近の記事リストに表示するセクションです。指定しない場合は、記事数が最も多いセクションが使用されます。
showViews 設定なし 記事とリストの表示回数を表示するかどうかです。これには Firebase 統合を有効にする必要があります。以下をご覧ください。
showLikes 設定なし 記事とリストのいいねを表示するかどうかです。これには Firebase 統合を有効にする必要があります。以下をご覧ください。
robots 設定なし ロボットがサイトをどのように処理するかを示す文字列です。設定されている場合、ページヘッダーに出力されます。有効な値については、Google のドキュメント を参照してください。
disableImageZoom false サイト内のすべての画像の画像ズーム機能を無効にします。
disableImageOptimization false サイト内のすべての画像の画像サイズ変更と最適化機能を無効にします。
disableTextInHeader false ヘッダーのテキストを無効にします。ロゴベースのヘッダーに役立ちます。
defaultBackgroundImage 設定なし background ホームページレイアウトと background ヒーロースタイルの両方のデフォルトの背景画像です。
defaultFeaturedImage 設定なし 記事全体のすべての featured 画像のデフォルトの背景画像です。ローカルの featured 画像によってオーバーライドされます。
highlightCurrentMenuArea 設定なし メインメニューのメニュー項目が選択されているときにマークを付けます。
smartTOC 設定なし スマート目次をアクティブにします。表示されている項目が強調表示されます。
smartTOCHideUnfocusedChildren 設定なし スマート目次がオンになっている場合、フォーカスされていないときに、テーブルのより深いレベルが非表示になります。

ヘッダー(Header)

名前 デフォルト 説明
header.layout "basic" サイト全体のヘッダーを定義します。サポートされている値は、basicfixedfixed-fillfixed-fill-blur です。
名前 デフォルト 説明
footer.showMenu true フッターメニューを表示/非表示にします。これは、config/_default/menus.en.toml ファイルの [[footer]] セクションで設定できます。
footer.showCopyright true サイトのフッターに著作権文字列を表示するかどうかです。文字列自体は、言語設定copyright パラメータを使用してカスタマイズできることに注意してください。
footer.showThemeAttribution true サイトのフッターに「powered by」テーマの帰属を表示するかどうかです。このメッセージを無効にする場合は、サイトの他の場所たとえば、about ページ)でテーマの帰属を検討してください。
footer.showAppearanceSwitcher false サイトのフッターに外観スイッチャーを表示するかどうかです。 ブラウザのローカルストレージを使用して、訪問者の設定が保持されます。
footer.showScrollToTop true true に設定すると、トップへスクロールの矢印が表示されます。

ホームページ(Homepage)

Name Default Description
homepage.layout "profile" The layout of the homepage. Valid values are page, profile, hero, card, background, or custom. When set to custom, you must provide your own layout by creating a /layouts/partials/home/custom.html file. Refer to the [Homepage Layout]({{< ref "homepage-layout" >}}) section for more details.
homepage.homepageImage Not set Image to be used in hero and card layouts. Can be set as local image from asset directory or external image url. Refer to the [Homepage Layout]({{< ref "homepage-layout" >}}) section for more details.
homepage.showRecent false Whether or not to display the recent articles list on the homepage.
homepage.showRecentItems 5 How many articles to display if showRecent is true. If variable is set to 0 or if it isn't defined the system will default to 5 articles.
homepage.showMoreLink false Whether or not to display a show more link at the end of your posts that takes the user to a predefined place.
homepage.showMoreLinkDest /posts The destination of the show more button.
homepage.cardView false Display recent articles as a gallery of cards.
homepage.cardViewScreenWidth false Enhance the width of the recent articles card gallery to take the full width available.
homepage.layoutBackgroundBlur false Makes the background image in the homepage layout blur with the scroll

Article

Name Default Description
article.showDate true Whether or not article dates are displayed.
article.showViews false Whether or not article views are displayed. This requires firebase integrations to be enabled, look below.
article.showLikes false Whether or not article likes are displayed. This requires firebase integrations to be enabled, look below.
article.showDateOnlyInArticle false Show date within article even if not displayed in article listings/cards.
article.showDateUpdated false Whether or not the dates articles were updated are displayed.
article.showAuthor true Whether or not the author box is displayed in the article footer.
article.showAuthorBottom false Author boxes are displayed at the bottom of each page instead of the top.
article.showHero false Whether the thumbnail image will be shown as a hero image within each article page.
article.heroStyle Not set Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.
article.layoutBackgroundBlur true Makes the background image in the background article heroStyle blur with the scroll
article.layoutBackgroundHeaderSpace true Add space between the header and the body.
article.showBreadcrumbs false Whether or not breadcrumbs are displayed in the article header.
article.showDraftLabel true Whether or not the draft indicator is shown next to articles when site is built with --buildDrafts.
article.showEdit false Whether or not the link to edit the article content should be displayed.
article.editURL Not set When article.showEdit is active, the URL for the edit link.
article.editAppendPath true When article.showEdit is active, whether or not the path to the current article should be appended to the URL set at article.editURL.
article.seriesOpened false Whether or not the series module will be displayed open by default or not.
article.showHeadingAnchors true Whether or not heading anchor links are displayed alongside headings within articles.
article.showPagination true Whether or not the next/previous article links are displayed in the article footer.
article.invertPagination false Whether or not to flip the direction of the next/previous article links.
article.showReadingTime true Whether or not article reading times are displayed.
article.showTableOfContents false Whether or not the table of contents is displayed on articles.
article.showRelatedContent false Display related content for each post. Might required additional configuration to your config.toml. Please check the theme config.toml if you want to enable this feature and copy all the relevant related entries. Also check Hugo's docs on related content.
article.relatedContentLimit 3 Limit of related articles to display if showRelatedContent is turned on.
article.showTaxonomies false Whether or not the taxonomies related to this article are displayed.
article.showAuthorsBadges false Whether the authors taxonomies are are displayed in the article or list header. This requires the setup of multiple authors and the authors taxonomy. Check [this page]({{< ref "multi-author" >}}) for more details on how to configure that feature.
article.showWordCount false Whether or not article word counts are displayed.
article.showComments false Whether or not the [comments partial]({{< ref "partials#comments" >}}) is included after the article footer.
article.sharingLinks Not set Which sharing links to display at the end of each article. When not provided, or set to false no links will be displayed. Available values are: "linkedin", "bluesky", "mastodon", "twitter", "reddit", "pinterest", "facebook", "email", "whatsapp", and "telegram"
article.showZenMode false Flag to activate Zen Mode reading feature for articles.

List

Name Default Description
list.showHero false Whether the thumbnail image will be shown as a hero image within each list page.
list.heroStyle Not set Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.
list.showBreadcrumbs false Whether or not breadcrumbs are displayed in the header on list pages.
list.layoutBackgroundBlur true Makes the background image in the background list heroStyle blur with the scroll
list.layoutBackgroundHeaderSpace true Add space between the header and the body.
list.showTableOfContents false Whether or not the table of contents is displayed on list pages.
list.showSummary false Whether or not article summaries are displayed on list pages. If a summary is not provided in the [front matter]({{< ref "front-matter" >}}), one will be auto generated using the summaryLength parameter in the site configuration.
list.showViews false Whether or not list views are displayed. This requires firebase integrations to be enabled, look below.
list.showLikes false Whether or not list likes are displayed. This requires firebase integrations to be enabled, look below.
list.showCards false Whether or not each article is displayed as a card or as simple inline text.
list.orderByWeight false Whether or not articles are sorted by weights.
list.groupByYear true Whether or not articles are grouped by year on list pages.
list.cardView false Display lists as a gallery of cards.
list.cardViewScreenWidth false Enhance the width of card galleries in lists to take the full width available.
list.constrainItemsWidth false Limit item width to prose to increase readability. Useful when no feature images are available.
list.showTableOfContents false Whether or not the table of contents is displayed on articles.

Sitemap

Name Default Description
sitemap.excludedKinds ["taxonomy", "term"] Kinds of content that should be excluded from the generated /sitemap.xml file. Refer to the Hugo docs for acceptable values.

Taxonomy

Name Default Description
taxonomy.showTermCount true Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.
taxonomy.showHero false Whether the thumbnail image will be shown as a hero image within each taxonomy page.
taxonomy.heroStyle Not set Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.
taxonomy.showBreadcrumbs false Whether or not breadcrumbs are displayed in the taxonomy header.
taxonomy.showViews false Whether or not article views are displayed. This requires firebase integrations to be enabled, look below.
taxonomy.showLikes false Whether or not article likes are displayed. This requires firebase integrations to be enabled, look below.
taxonomy.showTableOfContents false Whether or not the table of contents is displayed on taxonomies.
taxonomy.cardView false Display lists as a gallery of cards.

Term

Name Default Description
term.showHero false Whether the thumbnail image will be shown as a hero image within each term page.
term.heroStyle Not set Style to display the hero image, valid options are: basic, big, background, thumbAndBackground.
term.showBreadcrumbs false Whether or not breadcrumbs are displayed in the term header.
term.showViews false Whether or not article views are displayed. This requires firebase integrations to be enabled, look below.
term.showLikes false Whether or not article likes are displayed. This requires firebase integrations to be enabled, look below.
term.showTableOfContents false Whether or not the table of contents is displayed on terms.
term.groupByYear false Whether or not articles are grouped by year on term pages.
term.cardView false Display lists as a gallery of cards.
term.cardViewScreenWidth false Enhance the width of card galleries in lists to take the full width available.

Firebase

Name Default Description
firebase.apiKey Not set Firebase apiKey, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.authDomain Not set Firebase authDomain, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.projectId Not set Firebase projectId, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.storageBucket Not set Firebase storageBucket, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.messagingSenderId Not set Firebase messagingSenderId, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.appId Not set Firebase appId, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.
firebase.measurementId Not set Firebase measurementId, required to integrate against Firebase. Check [this page]({{< ref "firebase-views" >}}) for a guide on how to integrate Firebase into Blowfish.

Fathom Analytics

Name Default Description
fathomAnalytics.site Not set The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.
fathomAnalytics.domain Not set If using a custom domain with Fathom Analytics, provide it here to serve script.js from the custom domain.

Umami Analytics

Name Default Description
umamiAnalytics.websiteid Not set The site code generated by Umami Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.
umamiAnalytics.domain Not set If using a custom domain with Umami Analytics, provide it here to serve script.js from the custom domain.
umamiAnalytics.dataDomains Not set If you want the tracker to only run on specific domains, provide it for your tracker script. This is a comma delimited list of domain names. Such as "yoursite.com,yoursite2.com".
umamiAnalytics.scriptName script.js The name of the script.js used for anti-ad-blocking is configured by the environment variable TRACKER_SCRIPT_NAME
umamiAnalytics.enableTrackEvent true When set to true track event will add automatically. If you do not want to add track event, set it to false.

Seline Analytics

Name Default Description
selineAnalytics.token Not set The token generated by Seline Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.
selineAnalytics.enableTrackEvent true When set to true track event will add automatically. If you do not want to add track event, set it to false.

BuyMeACoffee

Name Default Description
buymeacoffee.identifier Not set The identifier to the target buymeacoffee account.
buymeacoffee.globalWidget Not set Activate the global buymeacoffee widget.
buymeacoffee.globalWidgetMessage Not set Message what will be displayed the first time a new user lands on the site.
buymeacoffee.globalWidgetColor Not set Widget color in hex format.
buymeacoffee.globalWidgetPosition Not set Position of the widget, i.e. "Left" or "Right"

Verifications

Name Default Description
verification.google Not set The site verification string provided by Google to be included in the site metadata.
verification.bing Not set The site verification string provided by Bing to be included in the site metadata.
verification.pinterest Not set The site verification string provided by Pinterest to be included in the site metadata.
verification.yandex Not set The site verification string provided by Yandex to be included in the site metadata.

RSSNext

Name Default Description
rssnext.feedId Not set The rss feedId string provided by RSSNext/Follow to be included in the rss.xml, which can helps to claim rss feed as your own.
rssnext.userId Not set The rss userId string provided by RSSNext/Follow to be included in the rss.xml, which can helps to claim rss feed as your own.

Other configuration files

The theme also includes a markup.toml configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Blowfish.

Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to function incorrectly and could result in unintended behaviour.