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

Docs: update screenshot path for npm #61

Closed
wants to merge 1 commit into from
Closed

Docs: update screenshot path for npm #61

wants to merge 1 commit into from

Conversation

aichbauer
Copy link

Fix:

  • update screenshot path from media/screenshot.gif to https://raw.githubusercontent.com/SamVerschueren/listr/master/media/screenshot.gif

The gif is not visible on the npm website. I added the absolut path to the img tag, so the gif is also displayed on the npm website, not only on github.

@sindresorhus
Copy link

This should already have been fixed by npm: npm/marky-markdown#320 Not sure why it's not working, but package authors shouldn't be forced to work around their continued brokenness.

@aichbauer
Copy link
Author

aichbauer commented May 17, 2017

If I get this right, you need to specify the right path for repositoryin the package.json. npm docs

I guess this could be the problem in this repo.

Right now its:

"repository": "SamVerschueren/listr",

Should be:

"repository" : { 
  "type" : "git",
  "url" : "https://github.com/SamVerschueren/listr.git"
}

Update: blog post on marky-markdown with relative URL support

@SamVerschueren
Copy link
Owner

Then it's still not working correctly because the docs indicate that the shorthand version I use here (and in every other repository) is valid as well. They know that my project is located on GitHub, hence the project link on the npm package page.

screen shot 2017-05-17 at 15 16 54

@aichbauer
Copy link
Author

Okay, that is true.

I run the tests from npm/marky-markdown with "repository": "name/repo", "repository": "github:name/repo", "repository": "https://github.com/name/repo" and

"repository": {
  "type": "git",
  "url": "https://github.com/name/repo"
}

the relative to absolut path conversion is only working for the last type.

But since this is a problem with npm/marky-markdown this PR is not relevant.

@aichbauer aichbauer closed this May 17, 2017
@SamVerschueren
Copy link
Owner

Care to create a new issue over there and link it here? I will definitely upvote it.

@aichbauer
Copy link
Author

I will as soon as I get to a computer.

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

Successfully merging this pull request may close these issues.

3 participants