Skip to content

Commit

Permalink
Docs: 完整支持 typeit shortcode (hugo-fixit/FixIt#483)
Browse files Browse the repository at this point in the history
  • Loading branch information
Lruihao committed Aug 4, 2024
1 parent 23aa915 commit 5bc8120
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,25 @@ The `typeit` shortcode has the following named parameters:

Grouping of content, the content of the same group will start typing animation in order.

- **speed** _[optional]_

{{< version 0.3.10 >}} Typing speed between each step (measured in milliseconds), default: `100`.

- **cursorSpeed** _[optional]_

{{< version 0.3.10 >}} Blinking speed of the cursor (measured in milliseconds), default: `1000`.

- **cursorChar** _[optional]_

{{< version 0.3.10 >}} Character used for the cursor (HTML format is supported), default: `|`.

- **duration** _[optional]_

{{< version 0.3.10 >}} Cursor duration after typing finishing (measured in milliseconds, `-1` means unlimited), default: `-1`.

- **loop** _[optional]_

Whether your content will continuously loop after completing.
{{< version 0.2.18 >}} Whether your content will continuously loop after completing.

## Simple Content {#simple-content}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,25 @@ categories:

内容分组,相同分组的内容将按顺序开始打字动画。

- **speed** _[可选]_

{{< version 0.3.10 >}} 每一步的打字速度 (单位是毫秒),默认:`100`

- **cursorSpeed** _[可选]_

{{< version 0.3.10 >}} 光标闪烁速度 (单位是毫秒),默认:`1000`

- **cursorChar** _[可选]_

{{< version 0.3.10 >}} 光标使用的字符 (支持 HTML 格式),默认:`|`

- **duration** _[可选]_

{{< version 0.3.10 >}} 打字动画完成后光标持续时间 (单位是毫秒,`-1` 表示无限),默认:`-1`

- **loop** _[可选]_

内容是否会在打字动画完成后继续循环。
{{< version 0.2.18 >}} 内容是否会在打字动画完成后继续循环。

## 简单内容 {#simple-content}

Expand Down

0 comments on commit 5bc8120

Please sign in to comment.