Making the README.md look nicer. #2

Merged
merged 2 commits into from May 17, 2013

Conversation

Projects
None yet
2 participants
@CoryG89
Collaborator

CoryG89 commented May 8, 2013

I was able to make the image and link work on the README.md by changing the HTML to the simpler markdown format.

Old HTML:

<a href="http://en.wikipedia.org/wiki/File:Jean_Auguste_Dominique_Ingres_019.jpg">
<img width="640" src="./node-romulus/raw/master/romulus.jpg">
</a>

New Markdown:

[![Romulus](romulus.jpg)](http://en.wikipedia.org/wiki/File:Jean_Auguste_Dominique_Ingres_019.jpg)

This looks like a great project that I'd like to contribute to in the future if I have the time, hoping to get it more attention by making the README look nicer.

Update README.md
Markdown image link format
@felixge

This comment has been minimized.

Show comment
Hide comment
@felixge

felixge May 13, 2013

Owner

@CoryG89 thx. Hotlinking is kinda bad, so it would be nicer to set the link to Github again. Anyway, added you as a collaborator, feel free to merge this one way or another.

btw. this used to work - github changed their urls ... : (

Owner

felixge commented May 13, 2013

@CoryG89 thx. Hotlinking is kinda bad, so it would be nicer to set the link to Github again. Anyway, added you as a collaborator, feel free to merge this one way or another.

btw. this used to work - github changed their urls ... : (

@CoryG89

This comment has been minimized.

Show comment
Hide comment
@CoryG89

CoryG89 May 15, 2013

Collaborator

@CoryG89 thx. Hotlinking is kinda bad, so it would be nicer to set the link to Github again. Anyway, added you as > a collaborator, feel free to merge this one way or another.

I think the markdown in my commit is pretty much the same as the HTML you had before. Here is what my markdown renders to:

<p><a href="http://en.wikipedia.org/wiki/File:Jean_Auguste_Dominique_Ingres_019.jpg"><img src="romulus.jpg" alt="Romulus" /></a></p>

The only difference is the p tags, and the alt text, which won't make a difference. This is not really an inline or 'hotlink' as the image is being pulled directly from romulus.jpg in the master branch. What we're doing is creating a regular (not hot) link to the original source image on Wikipedia, and the anchor just happens to contain our copy of the image. It would be hotlinking if we used the wikipedia image's link in the src attribute of the image, with or without the anchor.

btw. this used to work - github changed their urls ... : (

Yeah I figured so. GitHub changed the way their links work in markdown to support relative linking. Only downside is that it broke it for everyone doing it the other way.

Are you saying you don't want to link to Wikipedia? Would you rather link to the romulus.jpg file in your repo? If so I'll go ahead and do that and merge it in, otherwise I'll leave it as it is.

Collaborator

CoryG89 commented May 15, 2013

@CoryG89 thx. Hotlinking is kinda bad, so it would be nicer to set the link to Github again. Anyway, added you as > a collaborator, feel free to merge this one way or another.

I think the markdown in my commit is pretty much the same as the HTML you had before. Here is what my markdown renders to:

<p><a href="http://en.wikipedia.org/wiki/File:Jean_Auguste_Dominique_Ingres_019.jpg"><img src="romulus.jpg" alt="Romulus" /></a></p>

The only difference is the p tags, and the alt text, which won't make a difference. This is not really an inline or 'hotlink' as the image is being pulled directly from romulus.jpg in the master branch. What we're doing is creating a regular (not hot) link to the original source image on Wikipedia, and the anchor just happens to contain our copy of the image. It would be hotlinking if we used the wikipedia image's link in the src attribute of the image, with or without the anchor.

btw. this used to work - github changed their urls ... : (

Yeah I figured so. GitHub changed the way their links work in markdown to support relative linking. Only downside is that it broke it for everyone doing it the other way.

Are you saying you don't want to link to Wikipedia? Would you rather link to the romulus.jpg file in your repo? If so I'll go ahead and do that and merge it in, otherwise I'll leave it as it is.

@CoryG89

This comment has been minimized.

Show comment
Hide comment
@CoryG89

CoryG89 May 15, 2013

Collaborator

You're right though, I thought the problem at first was that GitHub was stripping out your HTML completely, however, this is just due to the relative linking issue, and simply changing the src in your HTML to romulus.jpg would have made it work as well.

Collaborator

CoryG89 commented May 15, 2013

You're right though, I thought the problem at first was that GitHub was stripping out your HTML completely, however, this is just due to the relative linking issue, and simply changing the src in your HTML to romulus.jpg would have made it work as well.

Update README.md
Linking to `romulus.jpg` in the repo instead of the source image on Wikipedia.

CoryG89 added a commit that referenced this pull request May 17, 2013

Merge pull request #2 from CoryG89/master
Making the README.md look nicer.

@CoryG89 CoryG89 merged commit cc7c170 into felixge:master May 17, 2013

@felixge

This comment has been minimized.

Show comment
Hide comment
@felixge

felixge May 18, 2013

Owner

Thx!

Owner

felixge commented May 18, 2013

Thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment