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

Add image directory #14

Closed
MaxHillebrand opened this issue Jul 21, 2019 · 7 comments · Fixed by #43
Closed

Add image directory #14

MaxHillebrand opened this issue Jul 21, 2019 · 7 comments · Fixed by #43
Labels
good first issue Good for newcomers question Further information is requested visual Regarding the UI of the documentation

Comments

@MaxHillebrand
Copy link
Contributor

We already have some Wasabi info-graphics, and will most certainly create more. Further, we will have several screenshots of Wasabi in the documentation.

Thus we need to implement the infrastructure to properly store the images in the repo and display the images in GitBook.

I'm not sure what is best practice, maybe @thunderbiscuit knows?

@MaxHillebrand MaxHillebrand added question Further information is requested visual Regarding the UI of the documentation labels Jul 21, 2019
@MaxHillebrand
Copy link
Contributor Author

For example the Installation Guide uses the following strategy.
Does this work together with gitbook?

  • Upload picture to imgur.
  • Write the link in the md like ![](https://imgur.com/wsJ66Qt.png)
  • Result:

@thunderbiscuit
Copy link
Contributor

Yes I noticed that. I'm not sure what is best/easier. Having them somewhere else or keeping them in the repo. For the images that are kept on the repo, I think the best way is to have a directory called something like img inside the docs. The links can reference the png images there.

@MaxHillebrand MaxHillebrand added the good first issue Good for newcomers label Jul 22, 2019
@MaxHillebrand MaxHillebrand changed the title Add image infrastructure Add image directory Jul 22, 2019
@MaxHillebrand
Copy link
Contributor Author

As I understand it, the image directory for VuePress is WasabiDoc/docs/.vuepress/publid?
So I can start uploading pictures there, and then link in the separate .md files to the image?

@thunderbiscuit
Copy link
Contributor

Yes that is right in theory. But to be honest I have had troubles with it in the past... If you test it let us know if it works for any markdown file anywhere in the repo.

@dennisreimann
Copy link
Contributor

@thunderbiscuit What have been the problems with that? I think this should be the prefered approach, because it is the simplest way of hosting and integrating the images.

@MaxHillebrand
Copy link
Contributor Author

MaxHillebrand commented Jul 31, 2019

The proper way to reference images is ![](/image.png)

@thunderbiscuit
Copy link
Contributor

Yeah sorry @dennisreimann I don't actually know what I was doing wrong. It's working for me now, and is definitely the recommended way to work it.

ACK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers question Further information is requested visual Regarding the UI of the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants