Last active
May 4, 2020 12:14
-
-
Save raine/413b9ed9fd437942af0e to your computer and use it in GitHub Desktop.
Browse Ramda documentation in Terminal
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/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 |
Thanks, this is very helpful. tempted to buy the alfred 2 license just for the convenience of ramda... much appreciated.
@raine - Would really love to do the same with Electron api docs:
https://github.com/electron/electron/releases/download/v1.4.1/electron-api.json
http://electron.atom.io/docs/all/
Can you take a look at these 2 links and tell me if it is possible (easy) - THANkS
Can anyone provide more detail on how I run this? I have installed jq and fzf thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
thanks for this 👍