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

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

Open
jules32 opened this issue Oct 19, 2023 · 3 comments
Open

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

jules32 opened this issue Oct 19, 2023 · 3 comments

Comments

@jules32
Copy link
Contributor

jules32 commented Oct 19, 2023

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 Openscapes/how_we_work#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
Copy link
Collaborator

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
Copy link
Contributor Author

jules32 commented Nov 5, 2023

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

@stefaniebutland
Copy link
Member

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

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

3 participants