dmy / elm-doc-preview

Elm offline documentation previewer
https://www.npmjs.com/package/elm-doc-preview
Other
128 stars 15 forks source link

Add a warning for markdown links starting by / as they won't work in final documentation #9

Closed rlefevre closed 5 years ago

rlefevre commented 5 years ago

Links added in some markdown as [Module](/Module) won't work in the final documentation because they will point to https://package.elm-lang.org/Module instead of https://package.elm-lang.org/packages/author/package/Module but they will work in the preview as the module is the only path segment there.

The correct way to link to another module that will work in both the final documentation and the preview is to use:

A warning should be added when clicking such broken links in the preview to allow the editor to fix them.

rlefevre commented 5 years ago

Version 3.0.0-rc1 and later uses exactly the same URL scheme that package.elm-lang.org, so errors should not be possible anymore.