Skip to content

Commit daf93a0

Browse files
authoredApr 14, 2025
Document recommended way to include images (#1570)
1 parent 849ad0a commit daf93a0

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed
 

‎README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ Code of Conduct, see `CODE_OF_CONDUCT.md` for more.
2828

2929
### Writing a new blog post
3030

31-
When writing a new blog post, keep in mind the file headers:
31+
If you want to include images in your post, please store them in the repository.
32+
You can store your main blog post in `content/<some-slug>/index.md`.
33+
Images go into the same directory: `content/<some-slug>/my_image.png`.
34+
Now you can reference that image with a simple relative path: `![alt text](my_image.png)`.
35+
36+
Here is an example of the front matter format:
3237
```md
3338
+++
3439
path = "2015/03/15/some-slug"

0 commit comments

Comments
 (0)