#elm #docs #search #offline

app elmdoc

A tool for searching Elm docs offline

3 releases

Uses old Rust 2015

0.1.3 Jun 23, 2017
0.1.2 Jun 23, 2017
0.1.1 Jun 12, 2017

#30 in #elm

MIT license

38KB
146 lines

elmdoc

So you want to do some Elm but you're on the train, or without Internet somehow. How do you read all the docs for the packages you're using? Elmdoc. That's how.

Screenshot of elmdoc searching for pair

Installation

(This will no doubt be easier when this is released properly, but for now...)

  1. Get you a Rust installed
  2. Clone this repository
  3. cargo install -- now you have an elmdoc

Usage

  1. Open a terminal in your Elm project (this will only work if you have downloaded packages with elm-package - i.e. there is a directory called elm-stuff in your project)
  2. elmdoc pair -- This should print out the docs for the Random.pair function

Dependencies

~0.5–0.9MB
~19K SLoC