https://github.com/wjlroe/elmdoc

A nascent offline Elm documentation searching thingy
https://github.com/wjlroe/elmdoc

cli docs elm elm-lang

Last synced: 3 months ago
JSON representation

A nascent offline Elm documentation searching thingy

• Host: GitHub
• URL: https://github.com/wjlroe/elmdoc
• Owner: wjlroe
• Archived: true
• Created: 2017-06-08T22:22:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-24T16:11:25.000Z (over 7 years ago)
• Last Synced: 2024-09-25T22:46:41.691Z (4 months ago)
• Topics: cli, docs, elm, elm-lang
• Language: Rust
• Size: 49.8 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# elmdoc

So you want to do some [Elm](http://elm-lang.org/) 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](search_pair.png)

## Installation

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

1. Get you a [Rust installed](https://rustup.rs/)

1. Ensure `$HOME/.cargo/bin` is on your `$PATH`

1. `cargo install elmdoc` -- 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