From 97a8274eb03d12ad54fb126d37d9386851311234 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Tue, 4 Mar 2025 06:28:07 +0100 Subject: [PATCH] add note about visual file types --- book/exercises/008.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/book/exercises/008.md b/book/exercises/008.md index b122b81..8e7c72d 100644 --- a/book/exercises/008.md +++ b/book/exercises/008.md @@ -1,6 +1,10 @@ # Exercise 8: Add visual media -To help you illustrate your content, it can be sueful to add some type of visual media such as figures or gifs. If you want to add a figure/gif to you book, you can refer to another website. This is quite handy but it does carry the risk that this figure/gif will no longer be visible if the location is changed. So it is better to add the source directly to the book. +To help you illustrate your content, it can be sueful to add some type of visual media such as figures or gifs. If you want to add a figure/gif to you book, you can refer to the URL to that image directly. This is quite handy but it does carry the risk that this figure file will no longer be visible if the location is changed, or if the website is down. Therefore, sometimes it can be better to add the source directly to the book (if done on small scale). + +```{note} +Unless you are using a file format like `*.svg`, the raw contents of a visual media file typically are not human-readable or have a binary file format. This is not an ideal file type to use with Git. When just beginning to learn about all the tools associated with a TeachBook, we recommend you keep things simple and do whatever is easiest for you. Note, however, that as your book grows (especially if you use a lot of non-svg images, you may want to find a different way to store them (guidance will be provided on this soon in the TeachBooks Manual---stay tuned! +``` `````{tab-set} ````{tab-item} Embedding