dmy / elm-doc-preview

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

Feature request: Generate docs.json, then exit #30

Closed runarfu closed 4 years ago

runarfu commented 4 years ago

I'm currently using (or rather misusing) elm-doc-preview to generate a docs.json for my application, using an elm-application.json as suggested in the README. I'm starting up elm-doc-preview for the sole purpose of generating the docs.json file, retrieving it with curl and then stopping the server again. This doesn't play well with build scripts, and I would like elm-doc-preview to have a CLI flag that does this:

rlefevre commented 4 years ago

You can use elm-doc-preview --output docs.json (or edp -o docs.json) in version 4.0.0 to generate the documentation and exit with a status code.