首頁資訊
Meta 資訊
用於告知頁面 meta 資訊的首頁資訊。
title
頁面的 <h1>
標題。此標題會顯示在頁面頂端和左側導覽列中。
您不需要將此文字新增為 <h1>
,因為 Gatsby 會從 title
標籤產生此標題。
注意
- 您可以用單引號包住
title
文字,但這不是強制性的。 - 如果您用單引號包住
title
文字,則無法在文字中加入撇號。
metaTitle
頁面的 <title>
標籤 - 回退至 title
(h1
)。
此標籤對於 Google SEO 很重要。如果我們希望,可以讓 metaTitle
比 title
更具描述性。
為了獲得良好的 SEO,請在此標籤中拼寫出縮寫,除非它們是業界標準。例如,拼寫出「Prisma Data Platform」,但使用縮寫「ORM」是可以的。
注意
- 您可以用單引號包住
metaTitle
文字,但這不是強制性的。 - 如果您用單引號包住
metaTitle
文字,則無法在文字中加入撇號。
sidebar_label
指定左側導覽列的不同標題,通常是較短的標題。
metaDescription
頁面的 <meta name="description" content="" />
。
注意
- 您可以用單引號包住
metaDescription
文字,但這不是強制性的。 - 如果您用單引號包住
metaDescription
文字,則無法在文字中加入撇號。
導覽 (左側邊欄)
設定導覽的首頁資訊。
duration
接受指定閱讀文章所需時間的字串。
範例:duration: '15 min'
preview
接受 true
或 false
(預設為 false
)。
在左側導覽列的頁面上新增 預覽
標籤。
deprecated
接受 true
或 false
(預設為 false
)。
在左側導覽列的頁面上新增 已棄用
標籤。
目錄 (右側邊欄)
toc
啟用或停用頁面上的目錄導覽 (預設為 false
)。例如
toc: true
tocDepth
控制頁面內目錄中顯示的標題深度
tocDepth: 2
注意:目前預設為最多到
h2
層級
搜尋
設定搜尋的首頁資訊。
search
接受 true
或 false
(預設為 true
)。
當設定為 false
時,會將頁面從搜尋結果中省略。
search: false
頁面內容
設定頁面內容的首頁資訊
langSwitcher
接受要在頁面中顯示為下拉式選單選項的語言陣列,以便在頁面之間切換內容
範例
langSwitcher: ['typescript', 'node']
dbSwitcher
接受要在頁面中顯示為下拉式選單選項的資料庫選項陣列,以便在頁面之間切換內容
範例
dbSwitcher: ['postgresql', 'mysql', 'sqlserver', 'planetscale', 'cockroachdb']
設計
設定頁面視覺外觀的首頁資訊。
wide
接受 true
或 false
(預設為 false
)。
當設定為 'true' 時,此頁面的內容寬度將為 988 像素,而不是預設的 748 像素。
範例
wide: true
注意
- 請僅將此用於具有無法閱讀的寬表格的頁面。