search

dmy / elm-doc-preview

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

Static site generation #43

Open gampleman opened 3 years ago

gampleman commented 3 years ago

I really love this tool!

For documenting an internal application, it would be easiest if we could generate the documentation as a static site we could deploy on our intranet, so that anyone can easily read the documentation. Would this be possible?

rlefevre commented 3 years ago

This is addressed in the FAQ, have you looked at https://github.com/ento/elm-doc? Wouldn't it fit your needs better?

gampleman commented 3 years ago

I have, but I don't really like having to set up a python environment just to get docs going.

rlefevre commented 3 years ago

I see. I guess it should be possible as the backend mostly compiles docs and send files to the frontend.

elm-doc-preview could prepare a directory structure with all the expected doc json files and the javascript/html needed to initialize the frontend.

I don't intend to work on this short term, but if someone wants to work on it, this can be discussed.

jjant commented 2 years ago

I'm also interested in this. Do you have an estimation on how much work it could be? I can volunteer.

rlefevre commented 2 years ago

I don't think there is that much work but I have not thought enough about it to give an estimation. It's mainly generating files using already existing functions, and copying some from the elm registry.

The main effort might be to keep both modes (dynamic/static) working without too much duplication.