asandikci.com/web
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases Packages Wiki Activity Actions

docs: update tutorial for defining preview image

Browse source
This commit is contained in:
Cotes Chung 2022-11-18 22:18:04 +08:00
parent da7d7e25b6
commit 782a930fdf
No known key found for this signature in database
GPG key ID: 0D9E54843167A808
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
_posts/2019-08-08-write-a-new-post.md
View file

@ -243,7 +243,7 @@ If you want to add an image to the top of the post contents, specify the attribu
```yaml
---
image:
path: /path/to/image/file
path: /path/to/image
width: 1000 # in pixels
height: 400 # in pixels
alt: image alternative text
@ -254,7 +254,11 @@ Except for `alt`, all other options are necessary, especially the `width` and `h
Starting from _Chirpy v5.0.0_, the attributes `height` and `width` can be abbreviated: `height` → `h`, `width` → `w`. In addition, the [`img_path`](#image-path) can also be passed to the preview image, that is, when it has been set, the attribute `path` only needs the image file name.
Starting from _Chirpy v5.2.0_, the property for the preview image is changed to `image.path`. If upgrading the theme from a prior version, you will have to update posts' metadata to use new image property.
For simple use, you can also just use `image` to define the path.
```yml
image: /path/to/image
```
## Pinned Posts