Add a preview server mix task with Bandit #2127
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey yall,
I realize this is the kind of thing that the core Elixir projects have often left up to userspace, but I think we should consider adding a built in preview server task to ex_doc.
This is based on something I use in my projects, using Bandit. I added Bandit >= 1.0.0 as an optional dependency.
I think this is the kind of thing most programming languages/tools should have, if you have a docs builder you may as well give the user/developer a way to quickly preview those docs without having to go to some external tool. I think it will benefit new users to elixir/ex_doc by being one less thing they have to think about to start working on documentation.
I would imagine we may want other docs in other locations, but I figure I'd just open this up for discussion first before sinking a bunch of time into that.