search

dmy / elm-doc-preview

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

Allow creating permalinks? #3

Closed ianmackenzie closed 6 years ago

ianmackenzie commented 6 years ago

Depending on how much you can do with Netlify's free tier, it would be really cool to have a "get permalink" button which would save the currently displayed docs to some sort of storage, then provide a permalink so that anyone else can view that documentation. This would be really helpful for sharing documentation snapshots on Slack etc. to get feedback on in-progress packages; currently the best approach is to upload README.md and docs.json to Slack and have others upload those to the previewer themselves.

rlefevre commented 6 years ago

I think that Netlify free tier is too limiting for that. But I have another idea, stay tuned...

rlefevre commented 6 years ago

The last version supports reading unpublished documentation from a github repo. See https://elm-doc-preview.netlify.com/ for details.

This also allows to share links (to functions, types, ...) from the remote documentation.

Hopefully this answers this feature request, so I will close it. Feel free to reopen the issue if this does not help your use cases.

ianmackenzie commented 6 years ago

Very cool, clever solution!

rlefevre commented 6 years ago

Thank you for the feature request.

This solution works because GitHub allows CORS requests to raw text files. Hopefully this won't change...