create-elm-app icon indicating copy to clipboard operation
create-elm-app copied to clipboard

Integrate elm-docs-preview application documentation

Open ChrisWellsWood opened this issue 4 years ago • 3 comments

A new version of elm-docs-preview has recently been released and it adds a cool feature called application documentation, which, as the name suggests, let you build documentation for your application. I've been messing about with this and think that it is really useful. Aside from the obvious benefits of encouraging you to actually document your application, it also enables you to browse the documentation for your dependencies offline. Here's an example that the author made from Richard Feldman's Real World SPA: https://elm-doc-preview.netlify.com/?repo=rlefevre/elm-spa-example

I think this might be the right kind of sensible default to add to create-elm-app, interested to hear what others think.

See this thread on Elm Discourse for more information.

ChrisWellsWood avatar Aug 16 '19 14:08 ChrisWellsWood

Hi Chris!

I like the idea of introducing this. :+1: Would you like to work on a PR?

halfzebra avatar Aug 17 '19 19:08 halfzebra

Yes, I will do. I should have some time over the next week.

ChrisWellsWood avatar Aug 18 '19 07:08 ChrisWellsWood

Nice, please let me know if you'll need any help!

halfzebra avatar Aug 18 '19 08:08 halfzebra