Skip to content

Instantly share code, notes, and snippets.

@arcseldon
Forked from raine/ramda
Created January 28, 2016 17:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save arcseldon/2bd72fc6d49438eb9956 to your computer and use it in GitHub Desktop.
Save arcseldon/2bd72fc6d49438eb9956 to your computer and use it in GitHub Desktop.
Browse Ramda documentation in Terminal
#!/usr/bin/env bash
# Browse Ramda documentation in Terminal
# Requires jq and a tool such as fzf or peco for interactive filtering
LATEST="http://raine.github.io/ramda-json-docs/latest.json"
DOCS_URL="http://ramdajs.com/docs/"
json=$(curl -s $LATEST)
functions=$(echo "$json" | jq -r '.[] | if .sig and (.sig | length > 0) then .name + " :: " + .sig else .name end')
fn=$(echo "$functions" | fzf --reverse) || exit 0
fn_name=$(echo $fn | awk '{print $1}')
desc=$(echo "$json" | jq -r ".[] | select(.name == \"$fn_name\") | .description" | fmt)
docs_url="$DOCS_URL#$fn_name"
echo "$fn"
echo
echo "$desc"
echo
echo "$docs_url"
# Open URL in browser
# open $docs_url # mac
# xdg-open $docs_url # linux
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment