Skip to content
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.

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

Syntax to include images in the MOOC #48

Open
annefou opened this issue Aug 28, 2024 · 1 comment
Open

Syntax to include images in the MOOC #48

annefou opened this issue Aug 28, 2024 · 1 comment

Comments

@annefou
Copy link
Contributor

annefou commented Aug 28, 2024

The current syntax used to include figures/images is:

![Datacube Economy](https://github.com/EO-College/cubes-and-clouds/blob/main/lectures/1.2_data_cube/assets/datacubes_economy.png "Example Data Cube Economy")

However, images do not render properly with Jupyter Book using this method. Would it make sense to use:

![Datacube Economy](https://raw.githubusercontent.com/EO-College/cubes-and-clouds/main/lectures/1.2_data_cube/assets/datacubes_economy.png "Example Data Cube Economy")

instead? Would this render properly on the EO-College platform?

With Jupyter Book, we also have the option to use the following MyST syntax:

  ```{figure} https://raw.githubusercontent.com/EO-College/cubes-and-clouds/main/lectures/1.2_data_cube/assets/datacubes_economy.png
  ---
  height: 350px
  name: datacube-economy
  ---
  Example Data Cube Economy


However, we may want to avoid this approach to keep things simple. 
@clausmichele
Copy link
Member

Hi Anne, in EO College everything is ported to WordPress, so it doesn't really matter. Here on GitHub though, the drawback of using raw links would be that if we ever change an image, we would also need to change the corresponding raw link. Not a big deal, but we need to be aware of it.
Anyway, if it's necessary to have the figures rendered in Jupyter Books, I would be in favor of switching to the second type of syntax, which is still Markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants