From d80918bf981d5df3f192346b44c0c35636ee7b2b Mon Sep 17 00:00:00 2001 From: Cooper Maruyama Date: Sat, 2 May 2015 07:16:27 -0700 Subject: add markdown extension to README --- plugins/coffee/README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 plugins/coffee/README.md (limited to 'plugins/coffee/README.md') diff --git a/plugins/coffee/README.md b/plugins/coffee/README.md new file mode 100644 index 000000000..d0e7bbe74 --- /dev/null +++ b/plugins/coffee/README.md @@ -0,0 +1,31 @@ +## Coffeescript Plugin + +This plugin provides aliases for quickly compiling and previewing your +cofeescript code. + +When writing Coffeescript it's very common to want to preview the output of a +certain snippet of code, either because you want to test the output or because +you'd like to execute it in a browser console which doesn't accept Coffeescript. + +Preview the compiled result of your coffeescript with `cf "code"` as per the +following: + +```zsh +$ cf 'if a then be else c' +if (a) { + b; +} else { + c; +} +``` + +Also provides the following aliases: + +* **cfc:** Copies the compiled JS to your clipboard. Very useful when you want + to run the code in a JS console. + +* **cfp:** Compiles from your currently copied clipboard. Useful when you want + to compile large/multi-line snippets + +* **cfpc:** Paste coffeescript from clipboard, compile to JS, then copy the + the result back to clipboard. -- cgit v1.2.3-70-g09d2