Skip to content
This repository
Browse code

Github now supports tables?

  • Loading branch information...
commit f52a25c33fb7ff7db3556f415c5b52530389d147 1 parent 40f849c
David Schoonover authored May 29, 2013

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

  1. 242  README.md
242  README.md
Source Rendered
@@ -48,231 +48,23 @@ npm link
48 48
 The compiler middleware takes a settings object, minimally containing a list of compilers to 
49 49
 enable (`enabled`). Most uses will also specify a source directory (`src`).
50 50
 
51  
-<table>
52  
-    <thead>
53  
-        <tr>
54  
-            <th>
55  
-                name
56  
-            </th>
57  
-            <th>
58  
-                type
59  
-            </th>
60  
-            <th>
61  
-                default
62  
-            </th>
63  
-            <th>
64  
-                description
65  
-            </th>
66  
-        </tr>
67  
-    </thead>
68  
-    <tbody>
69  
-        <tr>
70  
-            <td>
71  
-                <strong>enabled</strong>
72  
-            </td>
73  
-            <td>
74  
-                <code>String</code>, <code>String[]</code>
75  
-            </td>
76  
-            <td></td>
77  
-            <td>
78  
-                <strong>Required</strong> Enabled compiler id(s). See below for included compilers.
79  
-            </td>
80  
-        </tr>
81  
-        <tr>
82  
-            <td>
83  
-                <strong>src</strong>
84  
-            </td>
85  
-            <td>
86  
-                <code>String</code>, <code>String[]</code>
87  
-            </td>
88  
-            <td>
89  
-                cwd
90  
-            </td>
91  
-            <td>
92  
-                Directories to search for source files to compile.
93  
-            </td>
94  
-        </tr>
95  
-        <tr>
96  
-            <td>
97  
-                <strong>dest</strong>
98  
-            </td>
99  
-            <td>
100  
-                <code>String</code>
101  
-            </td>
102  
-            <td>
103  
-                <code>src</code> or<br>
104  
-                <code>src[0]</code> if Array
105  
-            </td>
106  
-            <td>
107  
-                Directory to write compiled result.
108  
-            </td>
109  
-        </tr>
110  
-        <tr>
111  
-            <td>
112  
-                <strong>roots</strong>
113  
-            </td>
114  
-            <td>
115  
-                <code>{src:dest, ...}</code>,<br>
116  
-                <code>[[src, dest], ...]</code>
117  
-            </td>
118  
-            <td></td>
119  
-            <td>
120  
-                Allows you to specify multiple, ordered <code>src</code>-<code>dest</code> pairs. One of <code>roots</code> or <code>src</code> is required; <code>roots</code> takes precedence over <code>src</code> if present.
121  
-            </td>
122  
-        </tr>
123  
-        <tr>
124  
-            <td>
125  
-                <strong>log_level</strong>
126  
-            </td>
127  
-            <td>
128  
-                <code>String</code> , <code>Number</code>
129  
-            </td>
130  
-            <td>
131  
-                <code>WARN</code>
132  
-            </td>
133  
-            <td>
134  
-                Logging verbosity. Valid values (case-insensitive): <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code>, <code>silent</code>, or a numeric constant (as found in <code>LOG</code>).
135  
-            </td>
136  
-        </tr>
137  
-        <tr>
138  
-            <td>
139  
-                <strong>create_dirs</strong>
140  
-            </td>
141  
-            <td>
142  
-                <code>Boolean</code>
143  
-            </td>
144  
-            <td>
145  
-                <code>true</code>
146  
-            </td>
147  
-            <td>
148  
-                Creates intermediate directories for destination files.
149  
-            </td>
150  
-        </tr>
151  
-        <tr>
152  
-            <td>
153  
-                <strong>mount</strong>
154  
-            </td>
155  
-            <td>
156  
-                <code>String</code>
157  
-            </td>
158  
-            <td></td>
159  
-            <td>
160  
-                Prefix trimmed off request path before matching/processing.
161  
-            </td>
162  
-        </tr>
163  
-        <tr>
164  
-            <td>
165  
-                <strong>delta</strong>
166  
-            </td>
167  
-            <td>
168  
-                <code>Number</code>
169  
-            </td>
170  
-            <td>
171  
-                <code>0</code>
172  
-            </td>
173  
-            <td>
174  
-                Delta <code>mtime</code> (in seconds) required for a derived file to be considered stale, and therefore recompiled. By default, any change will cause a file to be recompiled on next request.
175  
-            </td>
176  
-        </tr>
177  
-        <tr>
178  
-            <td>
179  
-                <strong>expires</strong>
180  
-            </td>
181  
-            <td>
182  
-                <code>Boolean</code>
183  
-            </td>
184  
-            <td>
185  
-                <code>false</code>
186  
-            </td>
187  
-            <td>
188  
-                Automatically treat files as stale if this old in secs.
189  
-            </td>
190  
-        </tr>
191  
-        <tr>
192  
-            <td>
193  
-                <strong>external_timeout</strong>
194  
-            </td>
195  
-            <td>
196  
-                <code>Number</code>
197  
-            </td>
198  
-            <td>
199  
-                <code>3000</code>
200  
-            </td>
201  
-            <td>
202  
-                Milliseconds after which to kill subprocess commands.
203  
-            </td>
204  
-        </tr>
205  
-        <tr>
206  
-            <td>
207  
-                <strong>cascade</strong>
208  
-            </td>
209  
-            <td>
210  
-                <code>Boolean</code>
211  
-            </td>
212  
-            <td>
213  
-                <code>false</code>
214  
-            </td>
215  
-            <td>
216  
-                Invoke all compilers that match? otherwise, only first.
217  
-            </td>
218  
-        </tr>
219  
-        <tr>
220  
-            <td>
221  
-                <strong>resolve_index</strong>
222  
-            </td>
223  
-            <td>
224  
-                <code>Boolean</code> , <code>String</code>
225  
-            </td>
226  
-            <td>
227  
-                <code>false</code>
228  
-            </td>
229  
-            <td>
230  
-                If <code>true</code>-y, directories are resolved with the supplied filename, where <code>true</code> maps to <code>'index.html'</code>.
231  
-            </td>
232  
-        </tr>
233  
-        <tr>
234  
-            <td>
235  
-                <strong>ignore</strong>
236  
-            </td>
237  
-            <td>
238  
-                <code>RegExp</code>
239  
-            </td>
240  
-            <td>
241  
-                <code>/\.(jpe?g|gif|png)$/i</code>
242  
-            </td>
243  
-            <td>
244  
-                Requests matching this pattern are short-circuit ignored, and no compiler matching occurs.
245  
-            </td>
246  
-        </tr>
247  
-        <tr>
248  
-            <td>
249  
-                <strong>allowed_methods</strong>
250  
-            </td>
251  
-            <td>
252  
-                <code>String[]</code>
253  
-            </td>
254  
-            <td>
255  
-                <code>['GET']</code>
256  
-            </td>
257  
-            <td>
258  
-                HTTP methods compiler should process. This setting is global-only -- per-compiler overrides specified via <code>options</code> will have no effect.
259  
-            </td>
260  
-        </tr>
261  
-        <tr>
262  
-            <td>
263  
-                <strong>options</strong>
264  
-            </td>
265  
-            <td>
266  
-                <code>{compilerId:settings, ...}</code>
267  
-            </td>
268  
-            <td></td>
269  
-            <td>
270  
-                Hash of additional per-compiler options, mapped by compiler id. Each compiler is supplied a copy of the <code>settings</code> object; if additional options are supplied in this way for a given compiler, they will be merged into the settings (and override any colliding top-level keys).
271  
-            </td>
272  
-        </tr>
273  
-    </tbody>
274  
-</table>
275  
-
  51
+| name                 | type                                          | default                          | description                                                                                                                                                                                                                                                                        |
  52
+| -------------------- | --------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  53
+| **enabled**          | `String`, `String[]`                          |                                  | **Required** Enabled compiler id(s). See below for included compilers.                                                                                                                                                                                                             |
  54
+| **src**              | `String`, `String[]`                          | cwd                              | Directories to search for source files to compile.                                                                                                                                                                                                                                 |
  55
+| **dest**             | `String`                                      | `src` or <br/> `src[0]` if Array | Directory to write compiled result.                                                                                                                                                                                                                                                |
  56
+| **roots**            | `{src:dest, ...}`, <br/> `[[src, dest], ...]` |                                  | Allows you to specify multiple, ordered `src`-`dest` pairs. One of `roots` or `src` is required; `roots` takes precedence over `src` if present.                                                                                                                                   |
  57
+| **log_level**        | `String` , `Number`                           | `WARN`                           | Logging verbosity. Valid values (case-insensitive): `error`, `warn`, `info`, `debug`, `silent`, or a numeric constant (as found in `LOG`).                                                                                                                                         |
  58
+| **create_dirs**      | `Boolean`                                     | `true`                           | Creates intermediate directories for destination files.                                                                                                                                                                                                                            |
  59
+| **mount**            | `String`                                      |                                  | Prefix trimmed off request path before matching/processing.                                                                                                                                                                                                                        |
  60
+| **delta**            | `Number`                                      | `0`                              | Delta `mtime` (in seconds) required for a derived file to be considered stale, and therefore recompiled. By default, any change will cause a file to be recompiled on next request.                                                                                                |
  61
+| **expires**          | `Boolean`                                     | `false`                          | Automatically treat files as stale if this old in secs.                                                                                                                                                                                                                            |
  62
+| **external_timeout** | `Number`                                      | `3000`                           | Milliseconds after which to kill subprocess commands.                                                                                                                                                                                                                              |
  63
+| **cascade**          | `Boolean`                                     | `false`                          | Invoke all compilers that match? otherwise, only first.                                                                                                                                                                                                                            |
  64
+| **resolve_index**    | `Boolean` , `String`                          | `false`                          | If `true`-y, directories are resolved with the supplied filename, where `true` maps to `'index.html'`.                                                                                                                                                                             |
  65
+| **ignore**           | `RegExp`                                      | `/\.(jpe?g!gif!png)$/i`          | Requests matching this pattern are short-circuit ignored, and no compiler matching occurs.                                                                                                                                                                                         |
  66
+| **allowed_methods**  | `String[]`                                    | `['GET']`                        | HTTP methods compiler should process. This setting is global-only -- per-compiler overrides specified via `options` will have no effect.                                                                                                                                           |
  67
+| **options**          | `{compilerId:settings, ...}`                  |                                  | Hash of additional per-compiler options, mapped by compiler id. Each compiler is supplied a copy of the `settings` object; if additional options are supplied in this way for a given compiler, they will be merged into the settings (and override any colliding top-level keys). |
276 68
 
277 69
 
278 70
 ## Compilers

0 notes on commit f52a25c

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