Skip to content

Commit 9beac0a

Browse files
committed
Fixing the readme for the 2.0.0 release.
1 parent 5902c1a commit 9beac0a

File tree

1 file changed

+7
-53
lines changed

1 file changed

+7
-53
lines changed

readme.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
**The less-middleware has recently been updated to version `1.0.4`.**
2-
3-
**If you are seeing an error similar to `TypeError: Arguments to path.join must be strings` please read the [migration guide](https://github.com/emberfeather/less.js-middleware/wiki/Migration-0.1.x-1.0.x) to update your code.**
4-
51
This middleware was created to allow processing of [Less](http://lesscss.org) files for [Connect JS](http://www.senchalabs.org/connect/) framework and by extension the [Express JS](http://expressjs.com/) framework.
62

73
[![Build Status](https://drone.io/github.com/emberfeather/less.js-middleware/status.png)](https://drone.io/github.com/emberfeather/less.js-middleware/latest)
@@ -41,11 +37,6 @@ The following options can be used to control the behavior of the middleware:
4137
</tr>
4238
</thead>
4339
<tbody>
44-
<tr>
45-
<th><code>compiler</code></th>
46-
<td>Options for the less compiler. See the "<code>compiler</code> Options" section below.</td>
47-
<td>&hellip;</td>
48-
</tr>
4940
<tr>
5041
<th><code>debug</code></th>
5142
<td>Show more verbose logging?</td>
@@ -66,11 +57,6 @@ The following options can be used to control the behavior of the middleware:
6657
<td>Only recompile once after each server restart. Useful for reducing disk i/o on production.</td>
6758
<td><code>false</code></td>
6859
</tr>
69-
<tr>
70-
<th><code>parser</code></th>
71-
<td>Options for the less parser. See the "<code>parser</code> Options" section below.</td>
72-
<td>&hellip;</td>
73-
</tr>
7460
<tr>
7561
<th><code>pathRoot</code></th>
7662
<td>Common root of the source and destination. It is prepended to both the source and destination before being used.</td>
@@ -101,6 +87,11 @@ The following options can be used to control the behavior of the middleware:
10187
<td>Function that modifies the less pathname before being loaded from the filesystem.</td>
10288
<td><code>function(pathname, req){...}</code></td>
10389
</tr>
90+
<tr>
91+
<th><code>render</code></th>
92+
<td>Options for the less render. See the "<code>render</code> Options" section below.</td>
93+
<td>&hellip;</td>
94+
</tr>
10495
<tr>
10596
<th><code>storeCss</code></th>
10697
<td>Function that is in charge of storing the css in the filesystem.</td>
@@ -114,9 +105,9 @@ The following options can be used to control the behavior of the middleware:
114105
</tbody>
115106
</table>
116107

117-
## `compiler` Options
108+
## `render` Options
118109

119-
The `options.compiler` is passed directly into the less parser with minimal defaults or changes by the middleware.
110+
The `options.render` is passed directly into the `less.render` with minimal defaults or changes by the middleware.
120111

121112
The following are the defaults used by the middleware:
122113

@@ -132,50 +123,13 @@ The following are the defaults used by the middleware:
132123
<th><code>compress</code></th>
133124
<td><code>auto</code></td>
134125
</tr>
135-
<tr>
136-
<th><code>sourceMap</code></th>
137-
<td><code>false</code></td>
138-
</tr>
139126
<tr>
140127
<th><code>yuicompress</code></th>
141128
<td><code>false</code></td>
142129
</tr>
143130
</tbody>
144131
</table>
145132

146-
## `parser` Options
147-
148-
The `options.parser` is passed directly into the less parser with minimal defaults or changes by the middleware.
149-
150-
The following are the defaults used by the middleware:
151-
152-
<table>
153-
<thead>
154-
<tr>
155-
<th>Option</th>
156-
<th>Default</th>
157-
</tr>
158-
</thead>
159-
<tbody>
160-
<tr>
161-
<th><code>dumpLineNumbers</code></th>
162-
<td><code>0</code></td>
163-
</tr>
164-
<tr>
165-
<th><code>paths</code></th>
166-
<td><code>[source]</code></td>
167-
</tr>
168-
<tr>
169-
<th><code>optimization</code></th>
170-
<td><code>0</code></td>
171-
</tr>
172-
<tr>
173-
<th><code>relativeUrls</code></th>
174-
<td><code>false</code></td>
175-
</tr>
176-
</tbody>
177-
</table>
178-
179133
## Examples
180134

181135
Common examples of using the Less middleware are available in the [wiki](https://github.com/emberfeather/less.js-middleware/wiki/Examples).

0 commit comments

Comments
 (0)