mafoo.org.uk/selfdefined
1
0
Fork 0
mirror of https://github.com/fooflington/selfdefined.git synced 2025-06-10 21:01:41 +00:00
Code Issues Projects Releases Wiki Activity

Add new front matter element: excerpt (#227)

Browse Source 
* This commit adds the excerpt front matter element, to show an
abbreviated version of the definition in social previews. This
also includes the documentation updates to support this change.

* This commit adds @olvb's suggestion to use 'set' to define the
alert & preview combo, to avoid repetitive code

* This commit updates the preview text to only include the flag if
it's "avoid" – if the flag is "warning" or there is no flag, it
will not appear at the beginning of the preview text.

Co-authored-by: Kathryn Grayson Nanz <kathryn@Kathryns-MacBook-Air.local>
Co-authored-by: Oscar <ovlb@users.noreply.github.com>
Co-authored-by: Kathryn <>
This commit is contained in:
Kathryn Grayson Nanz
2020-08-24 13:41:45 -04:00
committed by GitHub
parent 3808d4d80c
commit b872dbe384
7 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
11ty/documentation/front-matter.md
View File

@ -53,6 +53,20 @@ Whether or not the definition of this word is finished and should be displayed p
defined: true
```
## Excerpt
| Key | Type | required |
| ------- | ------- | -------- |
| excerpt | String | true |
An abbreviated version of the definition that will appear in social media previews. In the social preview, the excerpt will be prefaced with the flag level.
### Example
```yaml
excerpt: This is the short version of the definition that will appear in social previews.
```
## Speech
| Key | Type | required |