search

cdepillabout / pretty-simple

pretty-printer for Haskell data types that have a Show instance
https://hackage.haskell.org/package/pretty-simple
BSD 3-Clause "New" or "Revised" License
243 stars 29 forks source link

Use absolute URLs for images in README.md #109

Closed chshersh closed 2 years ago

chshersh commented 2 years ago

The images in README are not displayed on Hackage because the paths are relative. So I've changed URLs to absolute ones. I think some people still encounter pretty-simple on Hackage as their first occurrence so it would be good to have images displayed there as well 🎨

I also pessimistically removed the title part of the markdown rendering not being sure whether the current Hackage markdown supports this. To test this, one needs to create candidate releases and check the output 🤔

P.S. Feel free to close this PR if this is not what you want 🙂

georgefst commented 2 years ago

Definitely an improvement!

Do you know of an upstream cabal/haddock/hackage-server issue about actually fixing Hackage to be able to handle relative links?

chshersh commented 2 years ago

@georgefst I'm not aware of such an issue and haven't found one. It would be nice if hackage-server could support relative links but not sure if it's feasible for it to do so.

cdepillabout commented 2 years ago

Thanks!