Openscapes / website-new

Openscapes.org website, made with Quarto and GitHub, published with Netlify
https://openscapes.org
7 stars 3 forks source link

Use markdown for images (not R/knitr) #66

Open jules32 opened 10 months ago

jules32 commented 10 months ago

Hi @samanthacsik @stefaniebutland , I'm writing this here for us to implement going forward.

Here's an example of markdown (green) vs R (red) syntax for images:

image

I know Sam had good reasons for using R for images rather than markdown, but going forward let's use markdown. The reason is portability - we'll be cross-posting on the NASA-Openscapes blog post for now and not requiring R in post creation and GitHub Action is important (these websites otherwise don't rely on code, only quarto-flavored markdown).

See https://github.com/Openscapes/how_we_work/issues/292 for screenshots and details.

This to me would mean using Markdown syntax going forward, and updating the wiki, but I wanted to get your thoughts?

samanthacsik commented 10 months ago

I agree with everything you've written here @jules32 ! That was an oversight on my part, but let's definitely move forward with the language-agnostic markdown syntax.

I made a first pass at updates to the wiki: https://github.com/Openscapes/website-new/wiki/Adding-images

I didn't fully remove the information on knitr::include_graphics() since it still appears throughout the website, but open to feedback

jules32 commented 10 months ago

This sounds great, thank you Sam for updating the wiki!

stefaniebutland commented 10 months ago

@samanthacsik Just used your updated wiki info for images. Thank you!! (cause sometimes you never know if ppl read your documentation)