search

elm-lang / elm-package

Command line tool to share Elm libraries
BSD 3-Clause "New" or "Revised" License
214 stars 66 forks source link

Feature: elm package docs a-package #240

Open mgold opened 8 years ago

mgold commented 8 years ago

This is meant to go in the batch of work for the "packaging story". It would be a useful feature if running elm package docs elm-test pulled up the package.elm-lang.org webpage with the docs for that package, based on the version and repo installed in elm-package.json.

process-bot commented 8 years ago

Thanks for the issue! Make sure it satisfies this checklist. My human colleagues will appreciate it!

Here is what to expect next, and if anyone wants to comment, keep these things in mind.

pablomayobre commented 7 years ago

This is related to elm-lang/elm-make#28

@evancz proposed a solution that I consider is the best way to go. elm-package would download documentation.json from the packages.elm-lang.org site and place them inside the module folder. Then some tool can read it and turn it into more useful data like Markdown, HTML or other documentation format.

I'm also working on an Elm page that allows you to open a documentation.json and render it like in packages.elm-lang.org which should work offline. This is a project from elm-lang/project (added at elm-lang/project@85babf645782864323bb)

In addition to this I have created a script in JavaScript that searches the elm-stuff folder and downloads documentation.json files for each of the installed modules. (I have yet to release this since it's WIP)

In the future I would like to create an application (probably Electron + Elm) that searches elm-stuff to find documentation.json files for each module (download them if not found), and also find/create documentation.json files for all private modules in the project and display them in a tidy neat way

eeue56 commented 6 years ago

Check out elm-help, which allows you to do this sort of thing: https://www.npmjs.com/package/elm-help