dmy / elm-doc-preview

Elm offline documentation previewer

Home Page:https://www.npmjs.com/package/elm-doc-preview

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Allow creating permalinks?

ianmackenzie opened this issue · comments

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.

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

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.

Very cool, clever solution!

Thank you for the feature request.

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