Skip to content

Commit 6d02c82

Browse files
committed
Docs: Remove CSScomb Core docs
1 parent d7c5b81 commit 6d02c82

File tree

2 files changed

+2
-123
lines changed

2 files changed

+2
-123
lines changed

doc/plugins.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

doc/usage-node.md

Lines changed: 2 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -107,122 +107,7 @@ var config = comb.detectInString(css);
107107
comb.configure(config);
108108
```
109109

110-
## configure(config)
110+
## Public methods
111111

112-
Configure CSScomb.
113-
114-
Parameters:
115-
116-
* `{Object} config` — valid JSON object.
117-
118-
Example: Create and pass a config object to the method
119-
120-
```js
121-
var config = { 'always-semicolon': true };
122-
comb.configure(config);
123-
```
124-
125-
Example: Use config stored in a file
126-
127-
```js
128-
var config = require('path/to/.csscomb.json');
129-
comb.configure(config);
130-
```
131-
132-
See [configuration docs](configuration.md) for more information.
133-
134-
## getValue(optionName)
135-
136-
Get value of a given option.
137-
138-
Parameters:
139-
140-
* `{String} optionName` — name of option which value you want to get
141-
142-
Example: Get configured sort order
143-
144-
```js
145-
comb.getValue('sort-order');
146-
```
147-
148-
## processPath(path)
149-
150-
Comb a file or a directory.
151-
152-
Parameters:
153-
154-
* `{String} path` — path to file or directory
155-
156-
**Warning:** This method rewrites the file.
157-
158-
Example: Process one file
159-
160-
```js
161-
comb.processPath('main.scss');
162-
```
163-
164-
Example: Process whole directory
165-
166-
```js
167-
comb.processPath('assets/css');
168-
```
169-
170-
## processDirectory(path)
171-
172-
Comb all supported files in a directory.
173-
174-
Parameters:
175-
176-
* `{String} path` — path to a directory
177-
178-
**Warning:** This method rewrites the files.
179-
180-
Example:
181-
182-
```js
183-
comb.processDirectory('public/css');
184-
```
185-
186-
## processFile(path)
187-
188-
Comb one file.
189-
190-
Parameters:
191-
192-
* `{String} path` — path to a file
193-
194-
If file's syntax is not supported, the file will be ignored.
195-
196-
**Warning:** This method rewrites the file.
197-
198-
Example:
199-
200-
```js
201-
comb.processFile('print.less');
202-
```
203-
204-
## processString(string, syntax, filename)
205-
206-
Comb a stylesheet.
207-
208-
Parameters:
209-
210-
* `{String} text` — stylesheet that should be combed.
211-
* `{String} syntax` — style's syntax. Optional. Default value is `css`.
212-
* `{String} filename` — file's name that is used to print possible errors.
213-
Optional.
214-
215-
Example: Comb a css string
216-
217-
```js
218-
var css = 'a {top: 0; left: 0}';
219-
var combedCSS = comb.processString(css);
220-
```
221-
222-
Example: Comb a less string
223-
224-
```js
225-
var less = '@color: tomato; a {color: @color}';
226-
var combedLESS = comb.processString(less, 'less');
227-
```
112+
For the list of public methods and examples of their usage, see [CSScomb Core docs](https://github.com/csscomb/core).
228113

0 commit comments

Comments
 (0)