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

Serve generated docs #379

Closed
f-f opened this issue Aug 16, 2019 · 5 comments · Fixed by #421
Closed

Serve generated docs #379

f-f opened this issue Aug 16, 2019 · 5 comments · Fixed by #421

Comments

@f-f
Copy link
Member

f-f commented Aug 16, 2019

When doing spago docs one has to start a webserver in order to get the nice searchbar, and that adds friction.

Instead we should serve the docs with wai-app-static

@klntsky
Copy link
Collaborator

klntsky commented Aug 16, 2019

Why would we need to start a webserver?

It works with file:// for me.

I mean, that script injection trick was made exactly to avoid running a webserver.

@f-f
Copy link
Member Author

f-f commented Aug 16, 2019

Then we should at least display a link to it in spago docs (though I'm not sure how it would work on Windows, where the webserver thing will work for sure)

@klntsky
Copy link
Collaborator

klntsky commented Aug 16, 2019

Then we should at least display a link to it in spago docs

You mean, something like this:

Docs generated. Index is at "./generated-docs/index.html"
Link: file:///absolute/path/to/project/generated-docs/index.html

?

Then we could also add --open flag to either spago docs or docs-search build-index, to open that link in the browser.

@klntsky
Copy link
Collaborator

klntsky commented Aug 16, 2019

@DStranger
Copy link
Contributor

Hi guys! I'd like to give this one a try.

@DStranger DStranger mentioned this issue Sep 21, 2019
3 tasks
@f-f f-f closed this as completed in #421 Sep 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants