elm-doc-preview
This is a documentation previewer for Elm packages (>= 0.19),
It allows previewing README.md
and docs.json
files (generated with elm make --docs=docs.json
).
Online version
There is an online version supporting documentation loading from github that can be used for reviews:
https://elm-doc-preview.netlify.com
Local version
There is also a local version that supports hot reloading for convenient packages documentation editing:
$ npm install -g elm-doc-preview
Then, from the directory where your package elm.json
is:
$ elm-doc-preview
or from anywhere:
$ elm-doc-preview path/to/package
Credits