描述 Hugo 短代碼的參數定義,這對編寫短代碼文檔非常有用。
1{{% hugo/shortcode-params [data] %}}
data
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
#0 | data | string | ✓ | - | - |
數據文件名。
heading
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
- | heading | string | - | Parameters | - |
標題。
headingStartLevel
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
- | headingStartLevel | number | - | 2 | - |
開始標題的級別。
name
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
name | - | string | ✓ | - | - |
參數名。
position
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
position | - | number | - | - | - |
位置參數的索引。
type
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
type | - | string /array | - | string | - |
參數類型。
required
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
required | - | boolean | - | false | - |
表示參數是否必填。
default
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
default | - | string | - | - | - |
參數默認值。
since
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
since | - | string | - | - | - |
表示添加參數的版本。
description
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
description | - | string/object | ✓ | - | - |
參數說明,支持 Markdown。
description.default
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
description.default | - | string | - | - | - |
默認的參數說明。
description.[lang]
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
description.[lang] | - | string | - | - | - |
特定語言的描述。
options
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
options | - | array | - | - | - |
可選項。
deprecated
名稱 | 上下文 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
deprecated | - | string | - | false | - |
表示參數是否已被棄用。
1- name: foo
2 position: 0
3 required: true
4 description:
5 default: Foo description.
6 zh-hans: Foo 描述。
7 zh-hant: Foo 描述。
8
9- name: bar
10 type: number
11 since: v0.2.0
12 deprecated: true
13 description:
14 default: Bar description.
15 zh-hans: Bar 描述。
16 zh-hant: Bar 描述。
17
18- name: fizz
19 description: Single description without translations.
20 options:
21 - one
22 - two
Result as follows.
1{{% hugo/shortcode-params data="data/example-params.yaml" heading="Example Parameters" headingStartLevel=3 %}}
foo
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
#0 | foo | string | ✓ | - | - |
Foo 描述。
bar
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
- | bar | number | - | - | v0.2.0 |
Bar 描述。
fizz
索引 | 名稱 | 類型 | 必填 | 默認值 | 版本 |
---|---|---|---|---|---|
- | fizz | string | - | - | - |
Single description without translations.
可選項:one
, two
。