Params

Syntax

1{{% params [data] %}}

Parameters

data

The data filename.

heading

The heading.

headingStartLevel

The heading start level.

Data Item Properties

name

The parameter name.

type

The type of parameter.

required

Indicates whether if the parameter is required.

default

The default value of parameter.

since

Indicates the version in which the parameter is added.

description

The description, support Markdown.

description.default

The default description.

description.[lang]

Language-specific description.

options

Available options.

deprecated

Indicates whether if the parameter is deprecated.

Example

 1- name: foo
 2  required: true
 3  description:
 4    default: Foo description.
 5    zh-hans: Foo 描述。
 6    zh-hant: Foo 描述。
 7
 8- name: bar
 9  type: number
10  since: v0.2.0
11  deprecated: true
12  description:
13    default: Bar description.
14    zh-hans: Bar 描述。
15    zh-hant: Bar 描述。
16
17- name: fizz
18  description: Single description without translations.
19  options:
20    - one
21    - two

Result as follows.

1{{% params data="data/example-params.yaml" heading="Example Parameters" headingStartLevel=3 %}}

Example Parameters

foo

Foo description.

bar

Bar description.

fizz

Single description without translations.

Available options: one, two.