hugo-theme-next/exampleSite/content/post/shortcodes.md
2025-01-06 13:26:27 +08:00

154 lines
4.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "自定义短语示例"
description: "将常用的块引用、标签卡、按钮等信息设置成短代码,便于快速引用"
keywords: "shortcode,短代码"
date: 2022-08-06T14:41:50+08:00
lastmod: 2022-08-06T14:41:50+08:00
categories:
- 示例文章
- 语法
tags:
- 短代码
- 语法
url: "demo/shortcodes.html"
toc: true
music: true
---
虽然 `Markdown` 语法已经非常丰富能够满足我们写文章的绝大部分需求,但是为更好的对文章内容进行更友好的排版,为引设计一套自定义的短语,便于在使用时能够快速引用。
<!--more-->
## 块引用
在引用一些经典名言名句时,可以采用此短语,语法参考如下:
```markdown
{{</* quote */>}}
### block quote
写下你想表达的话语!
{{</* /quote */>}}
```
实际效果:
{{< quote >}}
希望是无所谓有,无所谓无的,这正如地上的路。
其实地上本没有路,走的人多了,也便成了路。
**鲁迅**
{{< /quote >}}
## 信息块
支持 `default``info``success``warning``danger` 等五种不同效果的展示,语法参考如下:
```markdown
{{</* note [class] [no-icon] */>}}
书写表达的信息
支持 Markdown 语法
{{</* /note */>}}
```
实际效果:
{{< note default no-icon >}}
### Default Header without icon
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note default >}}
### Default Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note primary >}}
### Primary Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note info >}}
### Info Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note success >}}
### Success Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note warning >}}
### Warning Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
{{< note danger >}}
### Danger Header
**Welcome** to [Hugo NexT!](https://preview.hugo-next.eu.org)
{{< /note >}}
## Bilibili 视频
```markdown
{{</* bilibili BV1Sx411T7QQ */>}}
或者
{{</* bilibili id=BV1Sx411T7QQ */>}}
```
{{</** bilibili id=BV1Sx411T7QQ **/>}}
## 音乐播放器
基于[APlayer](https://github.com/DIYgod/APlayer)和[MetingJS](https://github.com/metowolf/MetingJS)库实现见面内嵌的响应式音乐播放器自动识别的音乐平台URL包括`netease`、 `tencent``kugou``baidu``xiami` 平台,也可以支持用户自定义的音乐源。其他相关的参数说明如下:
| 参数名 | 默认 | 说明 |
| :----: | :------: | :--- |
| **id** | _必选_ | 音乐 ID即音乐在音乐平台的唯一标识符 |
| **server** | _必选_ | 音乐平台,支持 `netease``tencent``kugou``baidu``xiami` 平台 |
| **type** | _必选_ | 播放类型,目前支持 `song``playlist``album``search``artist` 类型 |
| **auto** | _可选_ | 音乐的地址,仅支持 server 参数中的平台 |
| **theme** | `#448aff` | 播放器的主题色,默认为 `#448aff` |
| **url** | 空 | 自定的音乐源 URL默认为空 |
| **name** | 空 | 音乐名称,默认为空 |
| **artist** | 空 | 音乐作者,默认为空 |
| **cover** | 空 | 音乐封面 URL默认为空 |
| **fixed** | `false` | 固定播放器,默认为 `false` |
| **mini** | `false` | 显示小播放器,默认为 `false` |
| **autoplay** | `false` | 自动播放,默认为 `false` |
| **loop** | `all` | 循环播放,支持`all`、`one` 和 `none`,默认为 `all` |
| **order** | `list` | 播放顺序`list` 和 `random`,支持默认为 `list` |
| **volume** | `0.7` | 音量,默认为 `0.7` |
| **mutex** | `true` | 有多个音乐播放时,是否只开启当前播放器,默认为 `true` |
| **list-folded** | `false` | 列表折叠,默认为 `false` |
| **list-max-height** | `340px` | 列表最大高度默认为340px |
### 单曲播放
```markdown
{{</* music theme="#2980b9" server="netease" type="song" id="1868553" mini="true" */>}}
```
{{< music theme="#2980b9" server="netease" type="song" id="1868553" mini="true" >}}
### 列表播放
```markdown
{{</* music server="netease" type="playlist" id="769332917" list-max-height="140" */>}}
```
{{< music server="netease" type="playlist" id="769332917" list-max-height="140px" >}}
### 自定义音乐源
```markdown
{{</* music url="https://ri-sycdn.kuwo.cn/ea345253b94e7ad564e6fb0cdf37fee6/677b6574/resource/n1/87/56/4272600974.mp3" name="天空之城" artist="宫崎骏" cover="http://img4.kuwo.cn/star/starheads/500/27/66/2532818318.jpg" autoplay="true" */>}}
```
{{< music url="https://ri-sycdn.kuwo.cn/ea345253b94e7ad564e6fb0cdf37fee6/677b6574/resource/n1/87/56/4272600974.mp3" name="天空之城" artist="宫崎骏" cover="http://img4.kuwo.cn/star/starheads/500/27/66/2532818318.jpg" autoplay="true" >}}