1

Is there any way for the README file to support automatic linking to known identifiers (eg. function names or module names), similar to how Haddock does it ?

Saurabh Nanda
  • 6,373
  • 5
  • 31
  • 60
  • To clarify: are you talking about the README as given at the bottom of the Hackage page, [like this one](https://hackage.haskell.org/package/yesod#readme)? If so, I don’t think there’s any way to link automatically (but I could be wrong), although there’s nothing stopping you from simply manually adding hyperlinks to the appropriate identifiers. – bradrn Apr 28 '20 at 11:20
  • @bradrn yes - that readme. If I manually add links, won't the need to be updated every time I bump the version of the library, else they'll keep pointing to the previous version, right? – Saurabh Nanda Apr 28 '20 at 11:22
  • Yes, I believe they will. (Although admittedly I’ve never published anything on Hackage yet, so I’m probably not the best person to talk about this.) – bradrn Apr 28 '20 at 13:20
  • If you elide the version number in the Hackage URL, it will always be redirected to the latest package version. E.g. http://hackage.haskell.org/package/base/docs/Data-List.html#v:head will always point at `Data.List.head` in the latest `base` on Hackage. – sjakobi Nov 17 '20 at 18:11

0 Answers0