pc5kflswa
/
docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add search bar.

Browse Source
JohnNiang-patch-1
Ryan Wang 3 years ago
parent cb89a8b4ee
commit 048ce27ce6
4 changed files with 177 additions and 266 deletions
Show Stats Download Patch File Download Diff File

133
docs/developer-guide/theme/page-variable.md
Unescape View File

@ -9,8 +9,7 @@ description: 每个页面所返回的变量
### posts（List） ### posts（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list posts.content as post> <#list posts.content as post>
@ -18,7 +17,7 @@ description: 每个页面所返回的变量
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -88,7 +87,7 @@ description: 每个页面所返回的变量
}] }]
``` ```
##### 示例 #### 示例
遍历输出首页的文章： 遍历输出首页的文章：
@ -118,8 +117,7 @@ description: 每个页面所返回的变量
### post（Object） ### post（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${post.attribute} ${post.attribute}
@ -127,7 +125,7 @@ ${post.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -199,7 +197,7 @@ ${post.attribute}
} }
``` ```
##### 示例 #### 示例
获取文章标题： 获取文章标题：
@ -215,8 +213,7 @@ ${post.attribute}
### prevPost（Object） ### prevPost（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${prevPost.attribute} ${prevPost.attribute}
@ -224,7 +221,7 @@ ${prevPost.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -296,7 +293,7 @@ ${prevPost.attribute}
} }
``` ```
##### 示例 #### 示例
获取上一篇文章的信息： 获取上一篇文章的信息：
@ -314,8 +311,7 @@ ${prevPost.attribute}
### nextPost（Object） ### nextPost（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${nextPost.attribute} ${nextPost.attribute}
@ -323,7 +319,7 @@ ${nextPost.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -395,7 +391,7 @@ ${nextPost.attribute}
} }
``` ```
##### 示例 #### 示例
获取下一篇文章的信息： 获取下一篇文章的信息：
@ -413,8 +409,7 @@ ${nextPost.attribute}
### categories（List） ### categories（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list categories as category> <#list categories as category>
@ -422,7 +417,7 @@ ${nextPost.attribute}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -438,7 +433,7 @@ ${nextPost.attribute}
}] }]
``` ```
##### 示例 #### 示例
获取文章的分类列表： 获取文章的分类列表：
@ -457,8 +452,7 @@ ${nextPost.attribute}
### tags（List） ### tags（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list tags as tag> <#list tags as tag>
@ -466,7 +460,7 @@ ${nextPost.attribute}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -479,7 +473,7 @@ ${nextPost.attribute}
}] }]
``` ```
##### 示例 #### 示例
获取文章的标签列表： 获取文章的标签列表：
@ -498,8 +492,7 @@ ${nextPost.attribute}
### metas（Object） ### metas（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${metas.key} ${metas.key}
@ -507,11 +500,11 @@ ${metas.key}
注：attribute 代表具体 key 值。 注：attribute 代表具体 key 值。
##### 参数 #### 参数
无 无
##### 示例 #### 示例
获取用户设置的音乐链接： 获取用户设置的音乐链接：
@ -531,8 +524,7 @@ ${metas.key}
### sheet（Object） ### sheet（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${sheet.attribute} ${sheet.attribute}
@ -540,7 +532,7 @@ ${sheet.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -583,7 +575,7 @@ ${sheet.attribute}
} }
``` ```
##### 示例 #### 示例
获取页面标题： 获取页面标题：
@ -599,8 +591,7 @@ ${sheet.attribute}
### metas（Object） ### metas（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${metas.key} ${metas.key}
@ -608,11 +599,11 @@ ${metas.key}
注：attribute 代表具体 key 值。 注：attribute 代表具体 key 值。
##### 参数 #### 参数
无 无
##### 示例 #### 示例
获取用户设置的音乐链接： 获取用户设置的音乐链接：
@ -632,8 +623,7 @@ ${metas.key}
### posts（List） ### posts（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list posts.content as post> <#list posts.content as post>
@ -641,7 +631,7 @@ ${metas.key}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -711,7 +701,7 @@ ${metas.key}
}] }]
``` ```
##### 示例 #### 示例
遍历输出归档页面的文章（无年份分组）： 遍历输出归档页面的文章（无年份分组）：
@ -731,8 +721,7 @@ ${metas.key}
### archives（List） ### archives（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list archives.content as archive> <#list archives.content as archive>
@ -740,7 +729,7 @@ ${metas.key}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
{ {
@ -803,7 +792,7 @@ ${metas.key}
} }
``` ```
##### 示例 #### 示例
遍历输出归档页面的文章（有年份分组）： 遍历输出归档页面的文章（有年份分组）：
@ -841,8 +830,7 @@ ${metas.key}
### posts（List） ### posts（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list posts.content as post> <#list posts.content as post>
@ -850,7 +838,7 @@ ${metas.key}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -920,7 +908,7 @@ ${metas.key}
}] }]
``` ```
##### 示例 #### 示例
遍历输出某个分类的文章： 遍历输出某个分类的文章：
@ -940,8 +928,7 @@ ${metas.key}
### category（Object） ### category（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${category.attribute} ${category.attribute}
@ -949,7 +936,7 @@ ${category.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -965,7 +952,7 @@ ${category.attribute}
} }
``` ```
##### 示例 #### 示例
```html ```html
<a href="${category.fullPath!}">分类：${category.name!}</a> <a href="${category.fullPath!}">分类：${category.name!}</a>
@ -989,8 +976,7 @@ ${category.attribute}
### posts（List） ### posts（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list posts.content as post> <#list posts.content as post>
@ -998,7 +984,7 @@ ${category.attribute}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -1068,7 +1054,7 @@ ${category.attribute}
}] }]
``` ```
##### 示例 #### 示例
遍历输出某个标签的文章： 遍历输出某个标签的文章：
@ -1088,8 +1074,7 @@ ${category.attribute}
### tag（Object） ### tag（Object）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${tag.attribute} ${tag.attribute}
@ -1097,7 +1082,7 @@ ${tag.attribute}
注：attribute 代表具体属性。 注：attribute 代表具体属性。
##### 参数 #### 参数
```json ```json
{ {
@ -1110,7 +1095,7 @@ ${tag.attribute}
} }
``` ```
##### 示例 #### 示例
```html ```html
<a href="${tag.fullPath!}">标签：${tag.name!}</a> <a href="${tag.fullPath!}">标签：${tag.name!}</a>
@ -1128,18 +1113,17 @@ ${tag.attribute}
### keyword（String） ### keyword（String）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
${keyword!} ${keyword!}
``` ```
##### 参数 #### 参数
无 无
##### 示例 #### 示例
```html ```html
搜索关键字为：${keyword!} 搜索关键字为：${keyword!}
@ -1147,8 +1131,7 @@ ${keyword!}
### posts（List） ### posts（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list posts.content as post> <#list posts.content as post>
@ -1156,7 +1139,7 @@ ${keyword!}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
[{ [{
@ -1226,7 +1209,7 @@ ${keyword!}
}] }]
``` ```
##### 示例 #### 示例
遍历输出某个搜索结果的文章： 遍历输出某个搜索结果的文章：
@ -1256,8 +1239,7 @@ ${keyword!}
### photos（List） ### photos（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list photos.content as photo> <#list photos.content as photo>
@ -1265,7 +1247,7 @@ ${keyword!}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
{ {
@ -1291,7 +1273,7 @@ ${keyword!}
} }
``` ```
##### 示例 #### 示例
```html ```html
<#list photos.content as photo> <#list photos.content as photo>
@ -1313,8 +1295,7 @@ ${keyword!}
### journals（List） ### journals（List）
#### Tabs {.tabset} #### 语法
##### 语法
```html ```html
<#list journals.content as journal> <#list journals.content as journal>
@ -1322,7 +1303,7 @@ ${keyword!}
</#list> </#list>
``` ```
##### 参数 #### 参数
```json ```json
{ {
@ -1347,7 +1328,7 @@ ${keyword!}
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul> <ul>

300
docs/developer-guide/theme/template-tag.md
Unescape View File

@ -3,15 +3,15 @@ title: 模板标签
description: 用于获取数据的模板标签 description: 用于获取数据的模板标签
--- ---
> 模板标签可以运用在页面的任何地方。 :::note
模板标签可以运用在页面的任何地方。
:::
## 文章（postTag） ## 文章（postTag）
### 获取最新文章（latest） ### 获取最新文章（latest）
#### latest {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="latest" top="获取条数"> <@postTag method="latest" top="获取条数">
@ -24,7 +24,7 @@ description: 用于获取数据的模板标签
1. method：latest 1. method：latest
2. top：所需要获取的条数 2. top：所需要获取的条数
##### 返回参数 #### 返回参数
posts: posts:
@ -74,7 +74,7 @@ posts:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="latest" top="3"> <@postTag method="latest" top="3">
@ -94,9 +94,7 @@ posts:
### 获取所有文章的数量（count） ### 获取所有文章的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="count"> <@postTag method="count">
@ -108,13 +106,13 @@ posts:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="count"> <@postTag method="count">
@ -130,9 +128,7 @@ count: long
### 根据年份归档（archiveYear） ### 根据年份归档（archiveYear）
#### archiveYear {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="archiveYear"> <@postTag method="archiveYear">
@ -144,7 +140,7 @@ count: long
1. method：archiveYear 1. method：archiveYear
##### 返回参数 #### 返回参数
archives: archives:
@ -197,7 +193,7 @@ archives:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="archiveYear"> <@postTag method="archiveYear">
@ -239,9 +235,7 @@ archives:
### 根据年月归档（archiveMonth） ### 根据年月归档（archiveMonth）
#### archiveMonth {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="archiveMonth"> <@postTag method="archiveMonth">
@ -253,7 +247,7 @@ archives:
1. method：archiveMonth 1. method：archiveMonth
##### 返回参数 #### 返回参数
archives: archives:
@ -307,7 +301,7 @@ archives:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="archiveMonth"> <@postTag method="archiveMonth">
@ -349,9 +343,7 @@ archives:
### 归档（archive） ### 归档（archive）
#### archive {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="archive" type="year or month"> <@postTag method="archive" type="year or month">
@ -364,7 +356,7 @@ archives:
1. method：archive 1. method：archive
2. type: `year` 或者 `month` 2. type: `year` 或者 `month`
##### 返回参数 #### 返回参数
archives(year): archives(year):
@ -470,7 +462,7 @@ archives(month):
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="archive" type="month"> <@postTag method="archive" type="month">
@ -512,9 +504,7 @@ archives(month):
### 根据分类 id 获取文章（listByCategoryId） ### 根据分类 id 获取文章（listByCategoryId）
#### listByCategoryId {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="listByCategoryId" categoryId="分类 id"> <@postTag method="listByCategoryId" categoryId="分类 id">
@ -527,7 +517,7 @@ archives(month):
1. method：listByCategoryId 1. method：listByCategoryId
2. categoryId：分类 id 2. categoryId：分类 id
##### 返回参数 #### 返回参数
posts: posts:
@ -577,7 +567,7 @@ posts:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="listByCategoryId" top="${category.id?c}"> <@postTag method="listByCategoryId" top="${category.id?c}">
@ -598,9 +588,7 @@ posts:
### 根据分类 slug 获取文章（listByCategorySlug） ### 根据分类 slug 获取文章（listByCategorySlug）
#### listByCategorySlug {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="listByCategorySlug" categorySlug="分类 slug"> <@postTag method="listByCategorySlug" categorySlug="分类 slug">
@ -613,7 +601,7 @@ posts:
1. method：listByCategorySlug 1. method：listByCategorySlug
2. categorySlug：分类 slug 2. categorySlug：分类 slug
##### 返回参数 #### 返回参数
posts: posts:
@ -663,7 +651,7 @@ posts:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="listByCategorySlug" categorySlug="${category.slug!}"> <@postTag method="listByCategorySlug" categorySlug="${category.slug!}">
@ -684,9 +672,7 @@ posts:
### 根据标签 id 获取文章（listByTagId） ### 根据标签 id 获取文章（listByTagId）
#### listByTagId {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="listByTagId" tagId="标签 id"> <@postTag method="listByTagId" tagId="标签 id">
@ -699,7 +685,7 @@ posts:
1. method：listByTagId 1. method：listByTagId
2. tagId：标签 id 2. tagId：标签 id
##### 返回参数 #### 返回参数
posts: posts:
@ -749,7 +735,7 @@ posts:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="listByTagId" tagId="${tag.id?c}"> <@postTag method="listByTagId" tagId="${tag.id?c}">
@ -770,9 +756,7 @@ posts:
### 根据标签 slug 获取文章（listByTagSlug） ### 根据标签 slug 获取文章（listByTagSlug）
#### listByTagSlug {.tabset} #### 语法
##### 语法
```html ```html
<@postTag method="listByTagSlug" tagSlug="标签 slug"> <@postTag method="listByTagSlug" tagSlug="标签 slug">
@ -785,7 +769,7 @@ posts:
1. method：listByTagSlug 1. method：listByTagSlug
2. tagSlug：标签 slug 2. tagSlug：标签 slug
##### 返回参数 #### 返回参数
posts: posts:
@ -835,7 +819,7 @@ posts:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@postTag method="listByTagSlug" tagSlug="${tag.slug!}"> <@postTag method="listByTagSlug" tagSlug="${tag.slug!}">
@ -858,9 +842,7 @@ posts:
### 获取最新评论（latest） ### 获取最新评论（latest）
#### latest {.tabset} #### 语法
##### 语法
```html ```html
<@commentTag method="latest" top="获取条数"> <@commentTag method="latest" top="获取条数">
@ -873,7 +855,7 @@ posts:
1. method：latest 1. method：latest
2. top：所需要获取的条数 2. top：所需要获取的条数
##### 返回参数 #### 返回参数
comments: comments:
@ -908,7 +890,7 @@ comments:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@commentTag method="latest" top="获取条数"> <@commentTag method="latest" top="获取条数">
@ -931,9 +913,7 @@ comments:
### 获取所有评论的数量（count） ### 获取所有评论的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@commentTag method="count"> <@commentTag method="count">
@ -945,13 +925,13 @@ comments:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@commentTag method="count"> <@commentTag method="count">
@ -969,9 +949,7 @@ count: long
### 获取所有分类目录（list） ### 获取所有分类目录（list）
#### list {.tabset} #### 语法
##### 语法
```html ```html
<@categoryTag method="list"> <@categoryTag method="list">
@ -983,7 +961,7 @@ count: long
1. method：list 1. method：list
##### 返回参数 #### 返回参数
categories: categories:
@ -1001,7 +979,7 @@ categories:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@categoryTag method="list"> <@categoryTag method="list">
@ -1020,9 +998,7 @@ categories:
### 获取文章的所有分类（listByPostId） ### 获取文章的所有分类（listByPostId）
#### listByPostId {.tabset} #### 语法
##### 语法
```html ```html
<@categoryTag method="listByPostId" postId="文章 id"> <@categoryTag method="listByPostId" postId="文章 id">
@ -1035,7 +1011,7 @@ categories:
1. method：listByPostId 1. method：listByPostId
2. postId：文章 id 2. postId：文章 id
##### 返回参数 #### 返回参数
categories: categories:
@ -1052,7 +1028,7 @@ categories:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@categoryTag method="listByPostId" postId="${post.id?c}"> <@categoryTag method="listByPostId" postId="${post.id?c}">
@ -1071,9 +1047,7 @@ categories:
### 获取所有分类的数量（count） ### 获取所有分类的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@categoryTag method="count"> <@categoryTag method="count">
@ -1085,13 +1059,13 @@ categories:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@categoryTag method="count"> <@categoryTag method="count">
@ -1109,9 +1083,7 @@ count: long
### 获取所有标签（list） ### 获取所有标签（list）
#### list {.tabset} #### 语法
##### 语法
```html ```html
<@tagTag method="list"> <@tagTag method="list">
@ -1123,7 +1095,7 @@ count: long
1. method：list 1. method：list
##### 返回参数 #### 返回参数
tags: tags:
@ -1139,7 +1111,7 @@ tags:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@tagTag method="list"> <@tagTag method="list">
@ -1158,9 +1130,7 @@ tags:
### 获取文章的所有标签（listByPostId） ### 获取文章的所有标签（listByPostId）
#### listByPostId {.tabset} #### 语法
##### 语法
```html ```html
<@tagTag method="listByPostId" postId="文章 id"> <@tagTag method="listByPostId" postId="文章 id">
@ -1173,7 +1143,7 @@ tags:
1. method：listByPostId 1. method：listByPostId
2. postId：文章 id 2. postId：文章 id
##### 返回参数 #### 返回参数
tags: tags:
@ -1188,7 +1158,7 @@ tags:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@tagTag method="listByPostId" postId="${post.id?c}"> <@tagTag method="listByPostId" postId="${post.id?c}">
@ -1207,9 +1177,7 @@ tags:
### 获取所有标签的数量（count） ### 获取所有标签的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@tagTag method="count"> <@tagTag method="count">
@ -1221,13 +1189,13 @@ tags:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@tagTag method="count"> <@tagTag method="count">
@ -1245,9 +1213,7 @@ count: long
### 获取所有菜单（list） ### 获取所有菜单（list）
#### list {.tabset} #### 语法
##### 语法
```html ```html
<@menuTag method="list"> <@menuTag method="list">
@ -1259,7 +1225,7 @@ count: long
1. method：list 1. method：list
##### 返回参数 #### 返回参数
menus: menus:
@ -1276,7 +1242,7 @@ menus:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@menuTag method="list"> <@menuTag method="list">
@ -1305,9 +1271,7 @@ menus:
### 获取多级菜单（tree） ### 获取多级菜单（tree）
#### tree {.tabset} #### 语法
##### 语法
```html ```html
<@menuTag method="tree"> <@menuTag method="tree">
@ -1319,7 +1283,7 @@ menus:
1. method：tree 1. method：tree
##### 返回参数 #### 返回参数
menus: menus:
@ -1347,7 +1311,7 @@ menus:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@menuTag method="tree"> <@menuTag method="tree">
@ -1393,9 +1357,7 @@ menus:
### 根据分组获取菜单（listByTeam） ### 根据分组获取菜单（listByTeam）
#### listByTeam {.tabset} #### 语法
##### 语法
```html ```html
<@menuTag method="listByTeam" team="team 名称"> <@menuTag method="listByTeam" team="team 名称">
@ -1408,7 +1370,7 @@ menus:
1. method：listByTeam 1. method：listByTeam
2. team：team 名称 2. team：team 名称
##### 返回参数 #### 返回参数
menus: menus:
@ -1425,7 +1387,7 @@ menus:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@menuTag method="listByTeam" team="main"> <@menuTag method="listByTeam" team="main">
@ -1454,9 +1416,7 @@ menus:
### 根据分组获取多级菜单（treeByTeam） ### 根据分组获取多级菜单（treeByTeam）
#### treeByTeam {.tabset} #### 语法
##### 语法
```html ```html
<@menuTag method="treeByTeam" team="team 名称"> <@menuTag method="treeByTeam" team="team 名称">
@ -1469,7 +1429,7 @@ menus:
1. method：treeByTeam 1. method：treeByTeam
2. team：team 名称 2. team：team 名称
##### 返回参数 #### 返回参数
menus: menus:
@ -1497,7 +1457,7 @@ menus:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@menuTag method="treeByTeam" team="main"> <@menuTag method="treeByTeam" team="main">
@ -1545,9 +1505,7 @@ menus:
### 获取所有友情链接（list） ### 获取所有友情链接（list）
#### list {.tabset} #### 语法
##### 语法
```html ```html
<@linkTag method="list"> <@linkTag method="list">
@ -1559,7 +1517,7 @@ menus:
1. method：list 1. method：list
##### 返回参数 #### 返回参数
links: links:
@ -1577,7 +1535,7 @@ links:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<ul> <ul>
@ -1612,9 +1570,7 @@ links:
### 乱序获取所有友情链接（listByRandom） ### 乱序获取所有友情链接（listByRandom）
#### listByRandom {.tabset} #### 语法
##### 语法
```html ```html
<@linkTag method="listByRandom"> <@linkTag method="listByRandom">
@ -1626,7 +1582,7 @@ links:
1. method：listByRandom 1. method：listByRandom
##### 返回参数 #### 返回参数
```json ```json
[{ [{
@ -1642,7 +1598,7 @@ links:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<ul> <ul>
@ -1677,9 +1633,7 @@ links:
### 获取分组友情链接（listTeams） ### 获取分组友情链接（listTeams）
#### listTeams {.tabset} #### 语法
##### 语法
```html ```html
<@linkTag method="listTeams"> <@linkTag method="listTeams">
@ -1691,7 +1645,7 @@ links:
1. method：listTeams 1. method：listTeams
##### 返回参数 #### 返回参数
teams: teams:
@ -1710,7 +1664,7 @@ teams:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@linkTag method="listTeams"> <@linkTag method="listTeams">
@ -1762,9 +1716,7 @@ teams:
### 乱序获取分组友情链接（listTeamsByRandom） ### 乱序获取分组友情链接（listTeamsByRandom）
#### listTeamsByRandom {.tabset} #### 语法
##### 语法
```html ```html
<@linkTag method="listTeamsByRandom"> <@linkTag method="listTeamsByRandom">
@ -1776,7 +1728,7 @@ teams:
1. method：listTeamsByRandom 1. method：listTeamsByRandom
##### 返回参数 #### 返回参数
teams: teams:
@ -1795,7 +1747,7 @@ teams:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@linkTag method="listTeamsByRandom"> <@linkTag method="listTeamsByRandom">
@ -1847,9 +1799,7 @@ teams:
### 获取所有友情链接的数量（count） ### 获取所有友情链接的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@linkTag method="count"> <@linkTag method="count">
@ -1861,13 +1811,13 @@ teams:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@linkTag method="count"> <@linkTag method="count">
@ -1885,9 +1835,7 @@ count: long
### 获取所有图片（list） ### 获取所有图片（list）
#### list {.tabset} #### 语法
##### 语法
```html ```html
<@photoTag method="list"> <@photoTag method="list">
@ -1899,7 +1847,7 @@ count: long
1. method：list 1. method：list
##### 返回参数 #### 返回参数
photos: photos:
@ -1918,7 +1866,7 @@ photos:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@photoTag method="list"> <@photoTag method="list">
@ -1938,9 +1886,7 @@ photos:
### 获取所有分组图片（listTeams） ### 获取所有分组图片（listTeams）
#### listTeams {.tabset} #### 语法
##### 语法
```html ```html
<@photoTag method="listTeams"> <@photoTag method="listTeams">
@ -1952,7 +1898,7 @@ photos:
1. method：listTeams 1. method：listTeams
##### 返回参数 #### 返回参数
teams: teams:
@ -1972,7 +1918,7 @@ teams:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@photoTag method="listTeams"> <@photoTag method="listTeams">
@ -2000,9 +1946,7 @@ teams:
### 根据分组获取图片（listByTeam） ### 根据分组获取图片（listByTeam）
#### listByTeam {.tabset} #### 语法
##### 语法
```html ```html
<@photoTag method="listByTeam" team="team 名称"> <@photoTag method="listByTeam" team="team 名称">
@ -2015,7 +1959,7 @@ teams:
1. method：listByTeam 1. method：listByTeam
2. team：team 名称 2. team：team 名称
##### 返回参数 #### 返回参数
photos: photos:
@ -2034,7 +1978,7 @@ photos:
}] }]
``` ```
##### 示例 #### 示例
```html ```html
<@photoTag method="listTeams" team="风景"> <@photoTag method="listTeams" team="风景">
@ -2054,9 +1998,7 @@ photos:
### 获取所有图片的数量（count） ### 获取所有图片的数量（count）
#### count {.tabset} #### 语法
##### 语法
```html ```html
<@photoTag method="count"> <@photoTag method="count">
@ -2068,13 +2010,13 @@ photos:
1. method：count 1. method：count
##### 返回参数 #### 返回参数
```json ```json
count: long count: long
``` ```
##### 示例 #### 示例
```html ```html
<@linkTag method="count"> <@linkTag method="count">
@ -2092,9 +2034,7 @@ count: long
### 获取首页文章列表的分页数据（index） ### 获取首页文章列表的分页数据（index）
#### index {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="index" page="${posts.number}" total="${posts.totalPages}" display="3"> <@paginationTag method="index" page="${posts.number}" total="${posts.totalPages}" display="3">
@ -2109,7 +2049,7 @@ count: long
3. total：总页数，通过 `${posts.totalPages}` 得到 3. total：总页数，通过 `${posts.totalPages}` 得到
3. display：页码展示数量 3. display：页码展示数量
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2127,7 +2067,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2181,9 +2121,7 @@ pagination：
### 获取文章归档列表的分页数据（archives） ### 获取文章归档列表的分页数据（archives）
#### archives {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="archives" page="${posts.number}" total="${posts.totalPages}" display="3"> <@paginationTag method="archives" page="${posts.number}" total="${posts.totalPages}" display="3">
@ -2198,7 +2136,7 @@ pagination：
3. total：总页数，通过 `${posts.totalPages}` 得到 3. total：总页数，通过 `${posts.totalPages}` 得到
3. display：页码展示数量 3. display：页码展示数量
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2216,7 +2154,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2270,9 +2208,7 @@ pagination：
### 获取搜索结果文章列表的分页数据（search） ### 获取搜索结果文章列表的分页数据（search）
#### search {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="search" page="${posts.number}" total="${posts.totalPages}" keyword="${keyword}" display="3"> <@paginationTag method="search" page="${posts.number}" total="${posts.totalPages}" keyword="${keyword}" display="3">
@ -2288,7 +2224,7 @@ pagination：
4. keyword: 关键词 4. keyword: 关键词
5. display：页码展示数量 5. display：页码展示数量
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2306,7 +2242,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2360,9 +2296,7 @@ pagination：
### 获取标签下文章列表的分页数据（tagPosts） ### 获取标签下文章列表的分页数据（tagPosts）
#### tagPosts {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="tagPosts" slug="${tag.slug!}" page="${posts.number}" total="${posts.totalPages}" display="3"> <@paginationTag method="tagPosts" slug="${tag.slug!}" page="${posts.number}" total="${posts.totalPages}" display="3">
@ -2378,7 +2312,7 @@ pagination：
3. display：页码展示数量 3. display：页码展示数量
4. slug：标签 slug 4. slug：标签 slug
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2396,7 +2330,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2450,9 +2384,7 @@ pagination：
### 获取分类下文章列表的分页数据（categoryPosts） ### 获取分类下文章列表的分页数据（categoryPosts）
#### categoryPosts {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="categoryPosts" slug="${category.slug!}" page="${posts.number}" total="${posts.totalPages}" display="3"> <@paginationTag method="categoryPosts" slug="${category.slug!}" page="${posts.number}" total="${posts.totalPages}" display="3">
@ -2468,7 +2400,7 @@ pagination：
3. display：页码展示数量 3. display：页码展示数量
4. slug：标签 slug 4. slug：标签 slug
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2486,7 +2418,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2540,9 +2472,7 @@ pagination：
### 获取图库页面图片列表的分页数据（photos） ### 获取图库页面图片列表的分页数据（photos）
#### photos {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="photos" page="${photos.number}" total="${photos.totalPages}" display="3"> <@paginationTag method="photos" page="${photos.number}" total="${photos.totalPages}" display="3">
@ -2557,7 +2487,7 @@ pagination：
3. total：总页数，通过 `${photos.totalPages}` 得到 3. total：总页数，通过 `${photos.totalPages}` 得到
3. display：页码展示数量 3. display：页码展示数量
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2575,7 +2505,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">
@ -2629,9 +2559,7 @@ pagination：
### 获取日志页面日志列表的分页数据（journals） ### 获取日志页面日志列表的分页数据（journals）
#### journals {.tabset} #### 语法
##### 语法
```html ```html
<@paginationTag method="journals" page="${journals.number}" total="${journals.totalPages}" display="3"> <@paginationTag method="journals" page="${journals.number}" total="${journals.totalPages}" display="3">
@ -2646,7 +2574,7 @@ pagination：
3. total：总页数，通过 `${journals.totalPages}` 得到 3. total：总页数，通过 `${journals.totalPages}` 得到
3. display：页码展示数量 3. display：页码展示数量
##### 返回参数 #### 返回参数
pagination： pagination：
@ -2664,7 +2592,7 @@ pagination：
} }
``` ```
##### 示例 #### 示例
```html ```html
<ul class="pagination"> <ul class="pagination">

5
docs/user-guide/markdown.md
Unescape View File

@ -130,14 +130,13 @@ pie title NETFLIX
## 短连接 ## 短连接
:::tip :::tip
> 这属于实验性特性，也许我们将在未来的版本移除这个特性。 这属于实验性特性，也许我们将在未来的版本移除这个特性。
::: :::
Halo 内置一些短连接以更好地支持一些 HTML 语法，但是编辑器目前并不能解析，只能发布之后才可以看到效果，如下： Halo 内置一些短连接以更好地支持一些 HTML 语法，但是编辑器目前并不能解析，只能发布之后才可以看到效果，如下：
### 网易云音乐 ### 网易云音乐
### Tabs {.tabset}
#### 语法 #### 语法
```markdown ```markdown
@ -158,7 +157,6 @@ Halo 内置一些短连接以更好地支持一些 HTML 语法，但是编辑器
### 哔哩哔哩动画 ### 哔哩哔哩动画
### Tabs {.tabset}
#### 语法 #### 语法
```markdown ```markdown
@ -179,7 +177,6 @@ Halo 内置一些短连接以更好地支持一些 HTML 语法，但是编辑器
## 脚注 ## 脚注
### Tabs {.tabset}
#### 语法 #### 语法
```markdown ```markdown

5
sidebars.js
Unescape View File

@ -81,6 +81,11 @@ module.exports = {
'developer-guide/theme/page-variable', 'developer-guide/theme/page-variable',
'developer-guide/theme/template-tag', 'developer-guide/theme/template-tag',
] ]
},
{
type: 'link',
label: 'REST API',
href: 'https://api.halo.run'
} }
], ],
}, },

Write Preview
Loading…
Cancel
Save