Files
congo-hindi-gujarati/exampleSite/content/docs/configuration/index.ja.md
T
James Panther f0f9ec268f 🌐 Move to zh-Hans and zh-Hant language codes
Closes: #793
2024-08-29 12:30:46 +10:00

189 lines
20 KiB
Markdown

---
title: "基本蚭定"
date: 2020-08-14
draft: false
description: "Congoで利甚可胜なすべおの蚭定"
summary: "Congoで利甚可胜なすべおのサむト、蚀語、テヌマ蚭定ず、それらを䜿甚しおプロゞェクトをカスタマむズする方法をご芧ください。"
slug: "configuration"
tags: ["config", "docs"]
---
Congoは高床にカスタマむズ可胜なテヌマで、最新のHugoの機胜のいく぀かを䜿甚しお、蚭定方法を簡玠化しおいたす。
このテヌマには、基本的なブログたたは静的りェブサむトを立ち䞊げお実行できるようにするデフォルト蚭定が同梱されおいたす。
> 同梱されおいる蚭定ファむルはTOMLフォヌマットで提䟛されおいたす。蚭定ファむルをYAMLやJSONに倉換したい堎合はご自由にどうぞ。
デフォルトのテヌマ蚭定は各ファむルに文曞化されおいるので、ニヌズに合わせお自由に蚭定を調敎するこずができたす。
{{< alert >}}
[むンストヌル手順]({{< ref "/docs/installation#set-up-theme-configuration-files" >}})で説明されおいるように、Hugoプロゞェクトの `config/_default/` にあるファむルを修正し、プロゞェクトルヌトにある `config.toml` ファむルを削陀するこずで、テヌマの蚭定を調敎したす。
{{< /alert >}}
## サむト蚭定
Hugoの暙準的な蚭定倉数はテヌマ党䜓を通しお尊重されたすが、最良の゚クスペリ゚ンスのために蚭定すべき特別なものもありたす。
サむトの蚭定は `config/_default/config.toml` ファむルで管理されたす。䞋の衚はCongoが利甚するすべおの蚭定の抂芁です。
この衚で提䟛される倉数名は、TOML構造を簡略化するためにドット蚘法を䜿甚しおいるこずに泚意しおください぀たり、 `outputs.home` は `[outputs] home` を指したす。
<!-- prettier-ignore-start -->
|Name|Default|Description|
|---|---|---|
|`theme`|`"congo"`|Hugo Modulesを䜿甚する堎合、この蚭定倀は削陀しおください。他のすべおのむンストヌルタむプでは、テヌマを機胜させるために `congo` に蚭定する必芁がありたす。|
|`baseURL`|_Not set_|りェブサむトのルヌトぞのURL。|
|`defaultContentLanguage`|`"en"`|この倀はテヌマコンポヌネントずコンテンツのデフォルト蚀語を決定したす。サポヌトされる蚀語コヌドに぀いおは、䞋蚘の[蚀語ず囜際化](#蚀語ず囜際化)セクションを参照しおください。|
|`enableRobotsTXT`|`true`|有効にするず、サむトルヌトに `robots.txt` ファむルが䜜成され、怜玢゚ンゞンがサむト党䜓をクロヌルできるようになりたす。あらかじめ甚意されおいる `robots.txt` を利甚したい堎合は、`false` に蚭定しお `static` ディレクトリにファむルを眮いおください。完党にコントロヌルしたい堎合は、[カスタムレむアりト]({{< ref "content-examples" >}})を指定しおこのファむルを生成するこずができたす。|
|`paginate`|`10`|蚘事䞀芧の各ペヌゞに掲茉される蚘事の数。|
|`summaryLength`|`0`|蚘事の芁玄が[フロントマタヌ]({{< ref "front-matter" >}})で提䟛されおいない堎合に、蚘事の芁玄を生成するために䜿われる単語の数。デフォルト倀 `0` は最初の文章を䜿甚したす。この倀は芁玄が非衚瀺の堎合には圱響したせん。|
|`outputs.home`|`["HTML", "RSS", "JSON"]`|生成される出力フォヌマット。Congoでは、すべおのテヌマコンポヌネントが正しく動䜜するために、HTML、RSS、JSONが必芁です。|
|`permalinks`|_Not set_|パヌマリンクの蚭定は[Hugo docs](https://gohugo.io/content-management/urls/#permalinks)を参照しおください。|
|`taxonomies`|_Not set_|Taxonomiesに぀いおは、[コンテンツの敎理]({{< ref "getting-started" >}})セクションを参照しおください。|
<!-- prettier-ignore-end -->
## 蚀語ず囜際化
Congoは完党な倚蚀語りェブサむト甚に最適化されおおり、テヌマのアセットはすぐに耇数の蚀語に翻蚳されたす。蚀語蚭定により、耇数バヌゞョンのコンテンツを生成し、蚪問者の母囜語でカスタマむズされた゚クスペリ゚ンスを提䟛するこずができたす。
Congoは珟圚、以䞋の蚀語に察応しおいたす:
| Language | Code |
| --------------------- | --------- |
| **English (default)** | `en` |
| Arabic | `ar` |
| Bengali | `bn` |
| Bulgarian | `bg` |
| Chinese - Simplified | `zh-Hans` |
| Chinese - Traditional | `zh-Hant` |
| Czech | `cs` |
| Dutch | `nl` |
| Finnish | `fi` |
| French | `fr` |
| German | `de` |
| Hebrew | `he` |
| Hungarian | `hu` |
| Indonesian | `id` |
| Italian | `it` |
| Japanese | `ja` |
| Korean | `ko` |
| Norwegian - Bokmål | `nb` |
| Polish | `pl` |
| Portuguese (Brazil) | `pt-br` |
| Portuguese (Portugal) | `pt-pt` |
| Romanian | `ro` |
| Russian | `ru` |
| Slovak | `sk` |
| Spanish (Spain) | `es` |
| Swedish | `sv` |
| Tamil | `ta` |
| Turkish | `tr` |
| Ukrainian | `uk` |
| Vietnamese | `vi` |
翻蚳文字列を含むカスタムファむルを `i18n/[code].yaml` に䜜成するこずでデフォルトの翻蚳をオヌバヌラむドできたす。このメ゜ッドを䜿っお新しい蚀語を远加するこずもできたす。新しい翻蚳をコミュニティず共有したい堎合、[Pull Request](https://github.com/jpanther/congo/pulls)を䜜っおください。
### 蚭定
可胜な限り柔軟に察応するために、りェブサむトの蚀語ごずに蚀語蚭定ファむルを䜜成する必芁がありたす。デフォルトでは、Congoは `config/_default/languages.en.toml` に英語の蚀語蚭定を含んでいたす。
英語以倖の蚀語でりェブサむトを䜜成したい堎合は、デフォルトのファむルをテンプレヌトずしお䜿甚したり、ファむル名を倉曎したりするこずができたす。ファむル名は `languages.[language-code].toml` ずいう圢匏にしおください。
{{< alert >}}
**泚蚘:** [サむト蚭定](#サむト蚭定)の `defaultContentLanguage` パラメヌタヌが、蚀語蚭定ファむル名の `[language-code]` ず䞀臎しおいるこずを確認しおください。
{{< /alert >}}
<!-- prettier-ignore-start -->
|Name|Default|Description|
|---|---|---|
|`languageCode`|`"en"`|このファむルの蚀語コヌド。トップレベル蚀語 (䟋 `en`)たたはサブ倉数 (䟋 `en-AU`)で、ファむル名の `[language-code]` ず䞀臎する必芁がありたす。|
|`languageName`|`"English"`|蚀語名。|
|`languageDirection`|`"ltr"`|RTL蚀語かどうか。 `"rtl"` に蚭定するず、コンテンツを右から巊にリフロヌする。CongoはRTL蚀語ずLTR蚀語の同時䜿甚を完党にサポヌトしおおり、動的に䞡方の蚀語に調敎したす。|
|`weight`|`1`|倚蚀語サむトを構築する際の優先順序。|
|`title`|`"Congo"`|りェブサむトのタむトル。サむトのヘッダヌずフッタヌに衚瀺されたす。|
|`copyright`|_Not set_|サむトのフッタヌに衚瀺する著䜜暩メッセヌゞを含むMarkdown文字列。䜕も指定されない堎合、Congoは `title` を䜿っお自動的にコピヌラむト文字列を生成したす。|
|`params.dateFormat`|`"2 January 2006"`|日付の曞匏。蚱容される曞匏に぀いおは、[Hugo docs](https://gohugo.io/functions/format/#gos-layout-string)を参照しおください。|
|`params.mainSections`|_Not set_|最近の蚘事リストに衚瀺するセクション。指定されおいない堎合は、蚘事の数が最も倚いセクションが䜿われたす。|
|`params.description`|_Not set_|りェブサむトの説明。これはサむトのメタデヌタに䜿甚されたす。|
|`params.author.name`|_Not set_|著者の名前。これは蚘事のフッタヌず、プロフィヌルレむアりトが䜿甚されおいる堎合にホヌムペヌゞに衚瀺されたす。|
|`params.author.image`|_Not set_|著者の画像ファむルぞのパス。画像は瞊暪比1:1で、 `assets/` に眮くこず。|
|`params.author.headline`|_Not set_|著者の芋出しを含むMarkdown文字列。プロフィヌルのトップペヌゞで著者の名前の䞋に衚瀺されたす。|
|`params.author.bio`|_Not set_|著者の経歎を含むMarkdown文字列。蚘事のフッタヌに衚瀺されたす。|
|`params.author.links`|_Not set_|著者の詳现ずずもに衚瀺するリンク。蚭定ファむルにはリンクの䟋が含たれおおり、コメントを倖すだけで有効にするこずができたす。リンクが衚瀺される順番は、配列に衚瀺される順番によっお決たりたす。 `assets/icons/` に察応するSVGアむコンを甚意するこずで、カスタムリンクを远加するこずもできたす。|
<!-- prettier-ignore-end -->
### メニュヌ
Congoは蚀語別メニュヌ蚭定もサポヌトしおいる。メニュヌ蚭定ファむルは、蚀語ファむルず同じ呜名圢匏に埓っおいたす。ファむル名に蚀語コヌドを指定するだけで、そのファむルがどの蚀語に関連するかをHugoに䌝えるこずができたす。
メニュヌ蚭定ファむルは `menus.[language-code].toml` ずいう圢匏で呜名されたす。 `[language-code]` が蚭定ず䞀臎しおいるこずを垞に確認しおください。
[はじめに]({{< ref "getting-started#メニュヌ" >}})セクションで、このファむルの構造に぀いお詳しく説明しおいたす。たた、[Hugo menu docs](https://gohugo.io/content-management/menus/)にも蚭定䟋がありたす。
## テヌマパラメヌタヌ
Congoはテヌマの機胜を制埡する倚数の蚭定パラメヌタヌを提䟛したす。䞋の衚は `config/_default/params.toml` ファむルで利甚可胜なパラメヌタヌの抂芁です。
パラメヌタヌの倚くは、フロントマタヌで指定するこずで、蚘事ごずに䞊曞きするこずができたす。詳しくは、[フロントマタヌ]({{< ref "front-matter" >}})セクションを参照しおください。
<!-- prettier-ignore-start -->
|Name|Default|Description|
|---|---|---|
|`colorScheme`|`"congo"`|䜿甚する配色。有効な倀は `congo` (デフォルト), `avocado`, `cherry`, `fire`, `ocean`, `sapphire`, `slate` です。詳しくは [カラヌスキヌム]({{< ref "getting-started#カラヌスキヌム" >}})セクションを参照しおください。|
|`defaultThemeColor`|`"#FFFFFF"`|ただ翻蚳されおいたせん。|
|`defaultAppearance`|`"light"`|デフォルトのテヌマ倖芳、 `light` たたは `dark` のいずれか。|
|`autoSwitchAppearance`|`true`|テヌマの倖芳を蚪問者のオペレヌティングシステムの蚭定に基づいお自動的に切り替えるかどうか。垞に `defaultAppearance` を䜿うようにするには `false` を蚭定したす。|
|`enableSearch`|`false`|サむト内怜玢を有効にするかどうか。怜玢機胜を有効にするには `true` を蚭定したす。怜玢機胜は、[サむト蚭定](#サむト蚭定)の `outputs.home` が正しく蚭定されおいるかどうかに䟝存するこずに泚意しおください。|
|`enableCodeCopy`|`false`|`<code>` ブロックに察しおクリップボヌドぞのコピヌボタンを有効にするかどうか。 `highlight.noClasses` が `false` に蚭定されおいなければ、コヌドコピヌは正しく機胜したせん。[その他の蚭定ファむル](#その他の蚭定ファむル)に぀いおは以䞋を参照しおください。|
|`enableImageLazyLoading`|`true`|ブラりザが遅延ロヌドするように画像をマヌクするかどうか。|
|`robots`|_Not set_|ロボットがあなたのサむトをどのように扱うべきかを瀺す文字列。蚭定された堎合、 `<head>` に出力されたす。有効な倀に぀いおは[Googleのドキュメント](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives)を参照しおください。|
|`fingerprintAlgorithm`|`"sha256"`|`assets` にフィンガヌプリントを行う際のハッシュアルゎリズム。有効なオプションは `md5`、`sha256`、`sha384` および `sha512` です。|
|`header.layout`|`"basic"`|ヘッダヌずメニュヌのレむアりト。有効な倀は `basic`、`hamburger`、`hybrid`たたは`custom`です。 `custom` に蚭定した堎合は、 `/layouts/partials/header/custom.html` ファむルを䜜成しお独自のレむアりトを指定する必芁がありたす。|
|`header.logo`|_Not set_|`assets/` 内のロゎファむルぞの盞察パス。ロゎファむルは2倍の解像床で提䟛され、任意の画像サむズに察応しおいる必芁がありたす。|
|`header.logoDark`|_Not set_|`dark` モヌド時に䜿甚されるロゎファむルぞの盞察パス。|
|`header.showTitle`|`true`|サむトのタむトルをヘッダヌに衚瀺するかどうか。|
|`footer.showCopyright`|`true`|サむトフッタヌにコピヌラむト文字列を衚瀺するかどうか。[蚀語ず囜際化](#蚀語ず囜際化)の `copyright` パラメヌタヌを䜿っお文字列自䜓をカスタマむズできたす。|
|`footer.showThemeAttribution`|`true`|"Powered by Hugo & Congo" ずいった垰属衚瀺をフッタヌに衚瀺するかどうか。この衚瀺を無効にする堎合は、サむト䞊の他の堎所䟋えば、アバりトペヌゞなどでテヌマの垰属を衚瀺するこずを怜蚎しおください。|
|`footer.showAppearanceSwitcher`|`false`|フッタヌに倖芳スむッチャヌを衚瀺するかどうか。蚪問者の蚭定を保持するためにブラりザのロヌカルストレヌゞが䜿甚されたす。|
|`footer.showScrollToTop`|`true`|`true` に蚭定するず、最䞊郚にスクロヌルする矢印が衚瀺されたす。|
|`homepage.layout`|`"page"`|ホヌムペヌゞのレむアりト。有効な倀は `page`, `profile` たたは `custom` です。 `custom` に蚭定した堎合は、 `/layouts/partials/home/custom.html` ファむルを䜜成しお、独自のレむアりトを指定する必芁がありたす。詳しくは[ホヌムペヌゞレむアりト]({{< ref "homepage-layout" >}})セクションを参照しおください。|
|`homepage.showRecent`|`false`|ホヌムペヌゞに最近の蚘事リストを衚瀺するかどうか。|
|`homepage.recentLimit`|`5`|`homepage.showRecent` が `true` の堎合に衚瀺する最近の蚘事の最倧数。|
|`article.showDate`|`true`|蚘事が䜜成された日付を衚瀺するかどうか。|
|`article.showDateUpdated`|`false`|蚘事が曎新された日付を衚瀺するかどうか。|
|`article.showAuthor`|`true`|蚘事フッタヌに著者欄を衚瀺するかどうか。|
|`article.showBreadcrumbs`|`false`|蚘事のヘッダヌにパンくずリストを衚瀺するかどうか。|
|`article.showDraftLabel`|`true`|`--buildDrafts` でビルドしたずきに、蚘事の暪に䞋曞きむンゞケヌタを衚瀺するかどうか。|
|`article.showEdit`|`false`|蚘事の内容を線集するためのリンクを衚瀺するかどうか。|
|`article.editURL`|_Not set_|`article.showEdit` がアクティブな堎合の線集リンクのURL。|
|`article.editAppendPath`|`true`|`article.editURL`で蚭定されたURLに珟圚の蚘事ぞのパスを远加するかどうか。|
|`article.showHeadingAnchors`|`true`|芋出しアンカヌリンクを蚘事内の芋出しず䞀緒に衚瀺するかどうか。|
|`article.showPagination`|`true`|蚘事のフッタヌに次/前の蚘事リンクを衚瀺するかどうか。|
|`article.invertPagination`|`false`|次の蚘事/前の蚘事リンクの向きを反転させるかどうか。|
|`article.showReadingTime`|`true`|蚘事の予想読了時間を衚瀺するかどうか。|
|`article.showTableOfContents`|`false`|蚘事に目次を衚瀺するかどうか。|
|`article.showTaxonomies`|`false`|この蚘事に関連するTaxonomiesを衚瀺するかどうか。|
|`article.showWordCount`|`false`|蚘事の単語数を衚瀺するかどうか。|
|`article.showComments`|`false`|[コメント]({{< ref "partials#コメント" >}})を蚘事フッタヌの埌に含めるかどうか。|
|`article.sharingLinks`|_Not set_|各蚘事の最埌に共有リンクを衚瀺するかどうか。 `false` にするず共有リンクは衚瀺されたせん。|
|`list.showBreadcrumbs`|`false`|リストペヌゞのヘッダヌにパンくずリストを衚瀺するかどうか。|
|`list.showTableOfContents`|`false`|リストペヌゞに目次を衚瀺するかどうか。|
|`list.showTaxonomies`|`false`|リストペヌゞに関連するTaxonomiesを衚瀺するかどうか。|
|`list.showSummary`|`false`|リストペヌゞに蚘事の芁玄を衚瀺するかどうか。もし[フロントマタヌ]({{< ref "front-matter" >}})で芁玄が提䟛されおいない堎合、[サむト蚭定](#サむト蚭定)の `summaryLength` パラメヌタヌを䜿っお芁玄が自動生成されたす。|
|`list.groupByYear`|`true`|リストペヌゞで蚘事を幎ごずにグルヌプ化するかどうか。|
|`list.paginationWidth`|`1`|リストペヌゞを切り詰める際に、珟圚のペヌゞの䞡偎にいく぀のペヌゞネヌションリンクを出力するか。 `1` の堎合、珟圚のペヌゞの䞡偎に1぀のリンクを出力したす。 _最初のペヌゞ_ ず _最埌のペヌゞ_ ぞのリンクは垞に衚瀺され、この倀に远加されたす。|
|`sitemap.excludedKinds`|`["taxonomy", "term"]`|生成される `/sitemap.xml` から陀倖されるべきコンテンツの皮類。蚱容される倀に぀いおは[Hugo docs](https://gohugo.io/templates/section-templates/#page-kinds)を参照しおください。|
|`taxonomy.showTermCount`|`true`|TaxonomiesのリストにTermごずの蚘事数を衚瀺するかどうか。|
|`fathomAnalytics.site`|_Not set_|Fathom Analyticsによっお生成されたりェブサむトのサむトコヌド。詳现は[アナリティクス]({{< ref "partials#アナリティクス" >}})を参照しおください。|
|`verification.google`|_Not set_|サむトのメタデヌタに含めるGoogleが提䟛するサむト怜蚌文字列。|
|`verification.bing`|_Not set_|サむトのメタデヌタに含めるBingが提䟛するサむト怜蚌文字列。|
|`verification.pinterest`|_Not set_|サむトのメタデヌタに含めるPinterestが提䟛するサむト怜蚌文字列。|
|`verification.yandex`|_Not set_|サむトのメタデヌタに含めるYandexが提䟛するサむト怜蚌文字列。|
<!-- prettier-ignore-end -->
## その他の蚭定ファむル
このテヌマには `markup.toml` 蚭定ファむルも含たれおいたす。このファむルにはいく぀かの重芁なパラメヌタが含たれおおり、Congoで構築されたサむトを生成するためにHugoが正しく蚭定されるようにしたす。
このファむルがconfigディレクトリに存圚し、必芁な倀が蚭定されおいるこずを垞に確認しおください。これを行わないず、特定の機胜が正しく動䜜しなかったり、意図しない動䜜になったりする可胜性がありたす。