Store

New in v0.139.0

Site 物件上的 Store 方法會創建一個持久的 備忘錄,用來儲存與操作資料。如果你想創建一個不附加於 Site 物件的本地作用範圍的備忘錄,可以使用 newScratch 函數。

方法

設置 (Set)

設置給定鍵的值。

{{ site.Store.Set "greeting" "Hello" }}
獲取 (Get)

獲取給定鍵的值。

{{ site.Store.Set "greeting" "Hello" }}
{{ site.Store.Get "greeting" }} → Hello
添加 (Add)

將給定的值加到已有的值上。

對於單一值,Add 接受能夠使用 Go 的 + 運算符的值。如果第一次為某個鍵使用 Add 時是陣列或切片,隨後的 Add 會將新值附加到該列表上。

{{ site.Store.Set "greeting" "Hello" }}
{{ site.Store.Add "greeting" "Welcome" }}
{{ site.Store.Get "greeting" }} → HelloWelcome
{{ site.Store.Set "total" 3 }}
{{ site.Store.Add "total" 7 }}
{{ site.Store.Get "total" }} → 10
{{ site.Store.Set "greetings" (slice "Hello") }}
{{ site.Store.Add "greetings" (slice "Welcome" "Cheers") }}
{{ site.Store.Get "greetings" }} → [Hello Welcome Cheers]
在 Map 中設置 (SetInMap)

接收一個 keymapKeyvalue,並將 mapKeyvalue 加到給定的 key 中。

{{ site.Store.SetInMap "greetings" "english" "Hello" }}
{{ site.Store.SetInMap "greetings" "french" "Bonjour" }}
{{ site.Store.Get "greetings" }} → map[english:Hello french:Bonjour]
刪除 Map 中的項目 (DeleteInMap)

接收一個 keymapKey,並刪除給定 key 中的 mapKey

{{ site.Store.SetInMap "greetings" "english" "Hello" }}
{{ site.Store.SetInMap "greetings" "french" "Bonjour" }}
{{ site.Store.DeleteInMap "greetings" "english" }}
{{ site.Store.Get "greetings" }} → map[french:Bonjour]
獲取已排序的 Map 值 (GetSortedMapValues)

返回根據 mapKey 排序後的 key 的值陣列。

{{ site.Store.SetInMap "greetings" "english" "Hello" }}
{{ site.Store.SetInMap "greetings" "french" "Bonjour" }}
{{ site.Store.GetSortedMapValues "greetings" }} → [Hello Bonjour]
刪除 (Delete)

刪除給定的鍵。

{{ site.Store.Set "greeting" "Hello" }}
{{ site.Store.Delete "greeting" }}

決定值

Store 方法通常用來設置在短代碼、由短代碼呼叫的部分模板,或是 Markdown 渲染鉤子內的備忘錄值。在這三種情況下,備忘錄值直到 Hugo 渲染頁面內容時才會確定。

如果需要從父模板訪問備忘錄值,而父模板尚未渲染頁面內容,你可以通過將返回值賦給一個 noop 變數來觸發內容渲染:

{{ $noop := .Content }}
{{ site.Store.Get "mykey" }}

你也可以使用 ContentWithoutSummaryFuzzyWordCountLenPlainPlainWordsReadingTimeSummaryTruncatedWordCount 等方法來觸發內容渲染。例如:

{{ $noop := .WordCount }}
{{ site.Store.Get "mykey" }}