Skip to content

Document recommended way to include images #1570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2025
Merged

Document recommended way to include images #1570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@ Code of Conduct, see `CODE_OF_CONDUCT.md` for more.

### Writing a new blog post

When writing a new blog post, keep in mind the file headers:
If you want to include images in your post, please store them in the repository.
You can store your main blog post in `content/<some-slug>/index.md`.
Images go into the same directory: `content/<some-slug>/my_image.png`.
Now you can reference that image with a simple relative path: `![alt text](my_image.png)`.

Here is an example of the front matter format:
```md
+++
path = "2015/03/15/some-slug"
Expand Down