Misleading message after doc generation
Closed this issue · 3 comments
When you're done generating the doc, dartdoc writes:
Success! Open file:///.../doc/api/index.html
But when you do this the search box is unavailable because the browser refuses to load the JSON index file. Maybe the message should mention this somehow. Maybe it could say something like "run python -m SimpleHttpClient in .../doc/ and point you browser to http://localhost:8000/api", which would work for most users. Or there could be dartdoc serve command.
Thanks! We should fix this. Patches welcome :)
We could embed a small web server into dartdoc. Maybe https://github.com/sethladd/simple_http_server ? (not sure how embeddable it is)
Opps, sorry for closing the issue by mistake, reopened.
Instead of embedding we could just tell users to run any server if they want to use the search box, and give a commandline example using simple_http_server.