Skip to content
This repository
Browse code

docs

  • Loading branch information...
commit 5283b4f6f3b493359bb7a0f3c5c62a7effad8b6f 1 parent fcec60f
TJ Holowaychuk authored August 30, 2011

Showing 1 changed file with 23 additions and 17 deletions. Show diff stats Hide diff stats

  1. 40  Readme.md
40  Readme.md
Source Rendered
@@ -811,31 +811,37 @@ a watcher-like behaviour:
811 811
 
812 812
      $ watch make
813 813
 
814  
-## bin/jade
  814
+## jade(1)
815 815
 
816  
-Output html to _stdout_:
  816
+```
  817
+
  818
+Usage: jade [options] [dir|file ...]
  819
+
  820
+Options:
817 821
 
818  
-    jade < my.jade > my.html
  822
+  -h, --help       output usage information
  823
+  -v, --version    output the version number
  824
+  -o, --obj <str>  javascript options object
  825
+  -O, --out <dir>  output the compiled html to <dir>
819 826
 
820  
-Generate _examples/*.html_:
  827
+Examples:
821 828
 
822  
-    jade examples/*.jade
  829
+  # translate jade the templates dir
  830
+  $ jade templates
823 831
 
824  
-Pass options:
  832
+  # create {foo,bar}.html
  833
+  $ jade {foo,bar}.jade
825 834
 
826  
-    jade examples/layout.jade --options '{ locals: { title: "foo" }}'
  835
+  # jade over stdio
  836
+  $ jade < my.jade > my.html
827 837
 
828  
-Usage info:
  838
+  # jade over stdio
  839
+  $ echo "h1 Jade!" | jade
829 840
 
830  
-    Usage: jade [options]
831  
-                [path ...]
832  
-                < in.jade > out.jade  
833  
-    Options:
834  
-      -o, --options <str>  JavaScript options object passed
835  
-      -h, --help           Output help information
836  
-      -w, --watch          Watch file(s) or folder(s) for changes and re-compile
837  
-      -v, --version        Output jade version
838  
-      --out <dir>          Output the compiled html to <dir>
  841
+  # foo, bar dirs rendering to /tmp
  842
+  $ jade foo bar --out /tmp 
  843
+
  844
+```
839 845
 
840 846
 ## License 
841 847
 

0 notes on commit 5283b4f

Please sign in to comment.
Something went wrong with that request. Please try again.