公告欄

公告欄模塊突出一些重要的事情,比如新聞和項目的新版本。

Modulegithub.com/hbstack/announcement-bar
Repository⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
UsageSee how to use modules.

站點參數

ParameterTypeDefaultDescription
bgstringprimary背景顏色。
colorstring#fff文本顏色。
intervalnumber5000公告的間隔,單位:毫秒。
expand_stall_thresholdnumber1000鼠標懸停於公告欄時展開所有公告所需要經過的毫秒數。

hugo.toml

1[params]
2  [params.hb]
3    [params.hb.announcement_bar]
4      expand_stall_threshold = 1000
5      interval = 5000

hugo.yaml

1params:
2  hb:
3    announcement_bar:
4      expand_stall_threshold: 1000
5      interval: 5000

hugo.json

 1{
 2   "params": {
 3      "hb": {
 4         "announcement_bar": {
 5            "expand_stall_threshold": 1000,
 6            "interval": 5000
 7         }
 8      }
 9   }
10}

公告數據文件

該模塊被設計爲兼容單語言和多語言站點,你需要於 data/announcements 目錄下爲每個語言站點創建公告數據文件。

1$ tree data/announcements
2├── en.toml
3├── zh-hans.toml
4└── zh-hant.toml

tree 的結果所示,我們爲 enzh-hanszh-hant 站點定義了公告數據文件。

公告屬性

PropertyTypeDefaultRequiredDescription
titlestring-Y公告標題,支持 Markdown 語法。
urlstring-N公告 URL。
weightnumber-N值越小優先級越高。

公告例子

data/announcements/en.toml

 1[external]
 2  title = 'The announcement linked to external site.'
 3  url = 'https://hugomods.com/'
 4  weight = 3
 5[internal]
 6  title = 'Internal announcement.'
 7  url = 'modules/enhancement/announcement-bar'
 8  weight = 2
 9[plain]
10  title = 'A **plain** text announcement.'
11  weight = 1

data/announcements/en.yaml

 1external:
 2  title: The announcement linked to external site.
 3  url: https://hugomods.com/
 4  weight: 3
 5internal:
 6  title: Internal announcement.
 7  url: modules/enhancement/announcement-bar
 8  weight: 2
 9plain:
10  title: A **plain** text announcement.
11  weight: 1

data/announcements/en.json

 1{
 2   "external": {
 3      "title": "The announcement linked to external site.",
 4      "url": "https://hugomods.com/",
 5      "weight": 3
 6   },
 7   "internal": {
 8      "title": "Internal announcement.",
 9      "url": "modules/enhancement/announcement-bar",
10      "weight": 2
11   },
12   "plain": {
13      "title": "A **plain** text announcement.",
14      "weight": 1
15   }
16}
razonyang
2024年6月15日 星期六 2023年6月11日 星期日