fbievan
/
website
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mention "alt" post param in readme

This commit is contained in:
GabMus 2022-10-09 21:21:15 +00:00
parent d900c73bd0
commit c46dc4b5f6
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -259,6 +259,7 @@ Every post can have various parameters in the frontmatter, here are some that yo
- `description`: a brief description of the post, useful for SEO optimization
- `tags`: an array of tags, useful for searching similar articles
- `image`: a link to a feature image for the article, shown in the preview as well
- `alt`: alternative text to be shown if image is not available or fails to download
- `imageCaption`: a markdown text rendered as a caption for the article image described above
- `featured`: boolean, indicate if the post should be shown as featured
- `comments`: boolean, if true it enables comments for the current post, if false it disables them (default is true)