Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Static site generation #43

Open
gampleman opened this issue Feb 25, 2021 · 5 comments
Open

Static site generation #43

gampleman opened this issue Feb 25, 2021 · 5 comments
Labels
enhancement New feature or request

Comments

@gampleman
Copy link

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
Copy link
Member

rlefevre commented Mar 8, 2021

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

@rlefevre rlefevre added the enhancement New feature or request label Mar 8, 2021
@gampleman
Copy link
Author

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

@rlefevre
Copy link
Member

rlefevre commented Mar 8, 2021

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
Copy link

jjant commented Feb 12, 2022

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

@rlefevre
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants