Open a package README.md, docs.json (from elm make --docs=docs.json) or
both:
Click Open Files on the side or drag & drop files anywhere in the page.
Invalid files will be ignored.
To share some unpublished package documentation (for example for review),
commit README.md and docs.json (generated with elm make --docs docs.json)
to a github repository and use the following query parameters:
repo
The github repository, for example
dmy/elm-doc-example.
version (optional, master by default)
The branch, tag or commit hash.
Examples with https://github.com/dmy/elm-doc-example:
Notes:
No data is sent to the server, so you can safely preview private packages documentation.
Local documentation is stored in the browser local storage to improve
navigation.
Closing the preview clears it.
When editing a package documentation, it is more convenient to see updates in real-time. For this you can use the local version that supports hot reloading, see https://www.npmjs.com/package/elm-doc-preview.
This version also supports applications in addition to packages.
Report bugs or feature requests at https://github.com/dmy/elm-doc-preview/issues.