saul365/LoveIt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update person shortcode docs

Browse Source
This commit is contained in:
Dillon
2022-06-05 23:22:51 +08:00
parent b32577783e
commit e13a4adb6a
2 changed files with 55 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
exampleSite/content/posts/theme-documentation-extended-shortcodes/index.en.md
View File

@@ -385,28 +385,28 @@ Raw content using Markdown syntax: {{< raw >}}**Hello**{{< /raw >}}
`person` is a shortcode to insert a link to a personal webpage marked up as [h-card](http://microformats.org/wiki/h-card).
The `person` shortcode takes the following parameters (all of these are optional, but it makes sense to have at least **url** and **name** and/or **nick**):
The `person` shortcode has the following named parameters:
* **url** (**first** positional parameter)
* **url** *[required]* (**first** positional parameter)
URL of the personal page.
* **name** (**second** positional parameter)
* **name** *[required]* (**second** positional parameter)
Name of the person.
* **nick**
Nickame of the person.
* **text** (**third** positional parameter)
* **text** *[optional]* (**third** positional parameter)
Text to display as hover tooltip of the link.
* **picture** (**fourth** positional parameter)
* **picture** *[optional]* (**fourth** positional parameter)
A picture to use as person's avatar.
* **nick** *[optional]*
Nickame of the person.
Example `person` input:
```markdown
@@ -420,3 +420,5 @@ Without an explicitly given picture, a generic icon is used. This input:
```markdown
{{</* person "https://dillonzq.com/" Dillon "author of the LoveIt theme" */>}}
```
This renders as {{< person "https://dillonzq.com/" Dillon "author of the LoveIt theme" >}}.