docs: split up into separate files like lib sass

nschonni · nschonni · commit 5bd15b1497db · 2016-05-06T00:43:59.000-04:00
diff --git a/README.md b/README.md
diff --git a/docs/api-data.md b/docs/api-data.md
@@ -0,0 +1,6 @@
+# data
+Type: `String`
+Default: `null`
+**Special**: `file` or `data` must be specified
+
+A string to pass to [LibSass] to render. It is recommended that you use `includePaths` in conjunction with this so that [LibSass] can find files when using the `@import` directive.
diff --git a/docs/api-file.md b/docs/api-file.md
@@ -0,0 +1,6 @@
+# file
+Type: `String`
+Default: `null`
+**Special**: `file` or `data` must be specified
+
+Path to a file for [LibSass] to render.
diff --git a/docs/api-functions.md b/docs/api-functions.md
@@ -0,0 +1,64 @@
+# functions (>= v3.0.0) - _experimental_
+
+**This is an experimental LibSass feature. Use with caution.**
+
+`functions` is an `Object` that holds a collection of custom functions that may be invoked by the sass files being compiled. They may take zero or more input parameters and must return a value either synchronously (`return ...;`) or asynchronously (`done();`). Those parameters will be instances of one of the constructors contained in the `require('node-sass').types` hash. The return value must be of one of these types as well. See the list of available types below:
+
+## types.Number(value [, unit = ""])
+* `getValue()`/ `setValue(value)` : gets / sets the numerical portion of the number
+* `getUnit()` / `setUnit(unit)` : gets / sets the unit portion of the number
+
+## types.String(value)
+* `getValue()` / `setValue(value)` : gets / sets the enclosed string
+
+## types.Color(r, g, b [, a = 1.0]) or types.Color(argb)
+* `getR()` / `setR(value)` : red component (integer from `0` to `255`)
+* `getG()` / `setG(value)` : green component (integer from `0` to `255`)
+* `getB()` / `setB(value)` : blue component (integer from `0` to `255`)
+* `getA()` / `setA(value)` : alpha component (number from `0` to `1.0`)
+
+Example:
+
+```javascript
+var Color = require('node-sass').types.Color,
+  c1 = new Color(255, 0, 0),
+  c2 = new Color(0xff0088cc);
+```
+
+## types.Boolean(value)
+* `getValue()` : gets the enclosed boolean
+* `types.Boolean.TRUE` : Singleton instance of `types.Boolean` that holds "true"
+* `types.Boolean.FALSE` : Singleton instance of `types.Boolean` that holds "false"
+
+## types.List(length [, commaSeparator = true])
+* `getValue(index)` / `setValue(index, value)` : `value` must itself be an instance of one of the constructors in `sass.types`.
+* `getSeparator()` / `setSeparator(isComma)` : whether to use commas as a separator
+* `getLength()`
+
+## types.Map(length)
+* `getKey(index)` / `setKey(index, value)`
+* `getValue(index)` / `setValue(index, value)`
+* `getLength()`
+
+## types.Null()
+* `types.Null.NULL` : Singleton instance of `types.Null`.
+
+## Example
+
+```javascript
+sass.renderSync({
+  data: '#{headings(2,5)} { color: #08c; }',
+  functions: {
+    'headings($from: 0, $to: 6)': function(from, to) {
+      var i, f = from.getValue(), t = to.getValue(),
+          list = new sass.types.List(t - f + 1);
+
+      for (i = f; i <= t; i++) {
+        list.setValue(i - f, new sass.types.String('h' + i));
+      }
+
+      return list;
+    }
+  }
+});
+```
diff --git a/docs/api-importers.md b/docs/api-importers.md
@@ -0,0 +1,33 @@
+# importer (>= v2.0.0) - _experimental_
+
+**This is an experimental LibSass feature. Use with caution.**
+
+Type: `Function | Function[]` signature `function(url, prev, done)`
+Default: `undefined`
+
+Function Parameters and Information:
+* `url (String)` - the path in import **as-is**, which [LibSass] encountered
+* `prev (String)` - the previously resolved path
+* `done (Function)` - a callback function to invoke on async completion, takes an object literal containing
+  * `file (String)` - an alternate path for [LibSass] to use **OR**
+  * `contents (String)` - the imported contents (for example, read from memory or the file system)
+
+Handles when [LibSass] encounters the `@import` directive. A custom importer allows extension of the [LibSass] engine in both a synchronous and asynchronous manner. In both cases, the goal is to either `return` or call `done()` with an object literal. Depending on the value of the object literal, one of two things will happen.
+
+When returning or calling `done()` with `{ file: "String" }`, the new file path will be assumed for the `@import`. It's recommended to be mindful of the value of `prev` in instances where relative path resolution may be required.
+
+When returning or calling `done()` with `{ contents: "String" }`, the string value will be used as if the file was read in through an external source.
+
+Starting from v3.0.0:
+
+* `this` refers to a contextual scope for the immediate run of `sass.render` or `sass.renderSync`
+
+* importers can return error and LibSass will emit that error in response. For instance:
+
+  ```javascript
+  done(new Error('doesn\'t exist!'));
+  // or return synchornously
+  return new Error('nothing to do here');
+  ```
+
+* importer can be an array of functions, which will be called by LibSass in the order of their occurrence in array. This helps user specify special importer for particular kind of path (filesystem, http). If an importer does not want to handle a particular path, it should return `null`. See [functions section](#functions--v300) for more details on Sass types.
diff --git a/docs/api-includepaths.md b/docs/api-includepaths.md
@@ -0,0 +1,5 @@
+# includePaths
+Type: `Array<String>`
+Default: `[]`
+
+An array of paths that [LibSass] can look in to attempt to resolve your `@import` declarations. When using `data`, it is recommended that you use this.
diff --git a/docs/api-indentedsyntax.md b/docs/api-indentedsyntax.md
@@ -0,0 +1,7 @@
+# indentedSyntax
+Type: `Boolean`
+Default: `false`
+
+`true` values enable [Sass Indented Syntax](http://sass-lang.com/documentation/file.INDENTED_SYNTAX.html) for parsing the data string or file.
+
+__Note:__ node-sass/libsass will compile a mixed library of scss and indented syntax (.sass) files with the Default setting (false) as long as .sass and .scss extensions are used in filenames.
diff --git a/docs/api-indenttype.md b/docs/api-indenttype.md
@@ -0,0 +1,5 @@
+# indentType (>= v3.0.0)
+Type: `String`
+Default: `space`
+
+Used to determine whether to use space or tab character for indentation.
diff --git a/docs/api-indentwidth.md b/docs/api-indentwidth.md
@@ -0,0 +1,6 @@
+# indentWidth (>= v3.0.0)
+Type: `Number`
+Default: `2`
+Maximum: `10`
+
+Used to determine the number of spaces or tabs to be used for indentation.
diff --git a/docs/api-info.md b/docs/api-info.md
@@ -0,0 +1,18 @@
+# Version information (>= v2.0.0)
+
+Both `node-sass` and `libsass` version info is now exposed via the `info` method:
+
+```javascript
+var sass = require('node-sass');
+
+console.log(sass.info);
+
+/*
+  it will output something like:
+
+  node-sass       2.0.1   (Wrapper)       [JavaScript]
+  libsass         3.1.0   (Sass Compiler) [C/C++]
+*/
+```
+
+Since node-sass >=v3.0.0 LibSass version is determined at run time.
diff --git a/docs/api-linefeed.md b/docs/api-linefeed.md
@@ -0,0 +1,5 @@
+# linefeed (>= v3.0.0)
+Type: `String`
+Default: `lf`
+
+Used to determine whether to use `cr`, `crlf`, `lf` or `lfcr` sequence for line break.
diff --git a/docs/api-omitsourcemapurl.md b/docs/api-omitsourcemapurl.md
@@ -0,0 +1,6 @@
+# omitSourceMapUrl
+Type: `Boolean`
+Default: `false`
+**Special:** When using this, you should also specify `outFile` to avoid unexpected behavior.
+
+`true` values disable the inclusion of source map information in the output file.
diff --git a/docs/api-outfile.md b/docs/api-outfile.md
@@ -0,0 +1,26 @@
+# outFile
+Type: `String | null`
+Default: `null`
+**Special:** Required when `sourceMap` is a truthy value
+
+Specify the intended location of the output file. Strongly recommended when outputting source maps so that they can properly refer back to their intended files.
+
+**Attention** enabling this option will **not** write the file on disk for you, it's for internal reference purpose only (to generate the map for example).
+
+Example on how to write it on the disk
+```javascript
+sass.render({
+    ...
+    outFile: yourPathTotheFile,
+  }, function(error, result) { // node-style callback from v3.0.0 onwards
+    if(!error){
+      // No errors during the compilation, write this result on the disk
+      fs.writeFile(yourPathTotheFile, result.css, function(err){
+        if(!err){
+          //file written on disk
+        }
+      });
+    }
+  });
+});
+```
diff --git a/docs/api-outputstyle.md b/docs/api-outputstyle.md
@@ -0,0 +1,6 @@
+# outputStyle
+Type: `String`
+Default: `nested`
+Values: `nested`, `expanded`, `compact`, `compressed`
+
+Determines the output format of the final CSS style.
diff --git a/docs/api-precision.md b/docs/api-precision.md
@@ -0,0 +1,5 @@
+# precision
+Type: `Integer`
+Default: `5`
+
+Used to determine how many digits after the decimal will be allowed. For instance, if you had a decimal number of `1.23456789` and a precision of `5`, the result will be `1.23457` in the final CSS.
diff --git a/docs/api-render-callback.md b/docs/api-render-callback.md
@@ -0,0 +1,89 @@
+# `render` Callback (>= v3.0.0)
+node-sass supports standard node style asynchronous callbacks with the signature of `function(err, result)`. In error conditions, the `error` argument is populated with the error object. In success conditions, the `result` object is populated with an object describing the result of the render call.
+
+## Error Object
+* `message` (String) - The error message.
+* `line` (Number) - The line number of error.
+* `column` (Number) - The column number of error.
+* `status` (Number) - The status code.
+* `file` (String) - The filename of error. In case `file` option was not set (in favour of `data`), this will reflect the value `stdin`.
+
+## Result Object
+* `css` (Buffer) - The compiled CSS. Write this to a file, or serve it out as needed.
+* `map` (Buffer) - The source map
+* `stats` (Object) - An object containing information about the compile. It contains the following keys:
+  * `entry` (String) - The path to the scss file, or `data` if the source was not a file
+  * `start` (Number) - Date.now() before the compilation
+  * `end` (Number) - Date.now() after the compilation
+  * `duration` (Number) - *end* - *start*
+  * `includedFiles` (Array) - Absolute paths to all related scss files in no particular order.
+
+## Examples
+
+```javascript
+var sass = require('node-sass');
+sass.render({
+  file: '/path/to/myFile.scss',
+  data: 'body{background:blue; a{color:black;}}',
+  importer: function(url, prev, done) {
+    // url is the path in import as is, which LibSass encountered.
+    // prev is the previously resolved path.
+    // done is an optional callback, either consume it or return value synchronously.
+    // this.options contains this options hash, this.callback contains the node-style callback
+    someAsyncFunction(url, prev, function(result){
+      done({
+        file: result.path, // only one of them is required, see section Special Behaviours.
+        contents: result.data
+      });
+    });
+    // OR
+    var result = someSyncFunction(url, prev);
+    return {file: result.path, contents: result.data};
+  },
+  includePaths: [ 'lib/', 'mod/' ],
+  outputStyle: 'compressed'
+}, function(error, result) { // node-style callback from v3.0.0 onwards
+  if (error) {
+    console.log(error.status); // used to be "code" in v2x and below
+    console.log(error.column);
+    console.log(error.message);
+    console.log(error.line);
+  }
+  else {
+    console.log(result.css.toString());
+
+    console.log(result.stats);
+
+    console.log(result.map.toString());
+    // or better
+    console.log(JSON.stringify(result.map)); // note, JSON.stringify accepts Buffer too
+  }
+});
+// OR
+var result = sass.renderSync({
+  file: '/path/to/file.scss',
+  data: 'body{background:blue; a{color:black;}}',
+  outputStyle: 'compressed',
+  outFile: '/to/my/output.css',
+  sourceMap: true, // or an absolute or relative (to outFile) path
+  importer: function(url, prev, done) {
+    // url is the path in import as is, which LibSass encountered.
+    // prev is the previously resolved path.
+    // done is an optional callback, either consume it or return value synchronously.
+    // this.options contains this options hash
+    someAsyncFunction(url, prev, function(result){
+      done({
+        file: result.path, // only one of them is required, see section Sepcial Behaviours.
+        contents: result.data
+      });
+    });
+    // OR
+    var result = someSyncFunction(url, prev);
+    return {file: result.path, contents: result.data};
+  }
+}));
+
+console.log(result.css);
+console.log(result.map);
+console.log(result.stats);
+```
diff --git a/docs/api-sourcecomments.md b/docs/api-sourcecomments.md
@@ -0,0 +1,5 @@
+# sourceComments
+Type: `Boolean`
+Default: `false`
+
+`true` enables additional debugging information in the output file as CSS comments
diff --git a/docs/api-sourcemap.md b/docs/api-sourcemap.md
@@ -0,0 +1,6 @@
+# sourceMap
+Type: `Boolean | String | undefined`
+Default: `undefined`
+**Special:** Setting the `sourceMap` option requires also setting the `outFile` option
+
+Enables the outputting of a source map during `render` and `renderSync`. When `sourceMap === true`, the value of `outFile` is used as the target output location for the source map. When `typeof sourceMap === "string"`, the value of `sourceMap` will be used as the writing location for the file.
diff --git a/docs/api-sourcemapcontent.md b/docs/api-sourcemapcontent.md
@@ -0,0 +1,5 @@
+# sourceMapContents
+Type: `Boolean`
+Default: `false`
+
+`true` includes the `contents` in the source map information
diff --git a/docs/api-sourcemapembed.md b/docs/api-sourcemapembed.md
@@ -0,0 +1,5 @@
+# sourceMapEmbed
+Type: `Boolean`
+Default: `false`
+
+`true` embeds the source map as a data URI
diff --git a/docs/api-sourcemaproot.md b/docs/api-sourcemaproot.md
@@ -0,0 +1,5 @@
+# sourceMapRoot
+Type: `String`
+Default: `undefined`
+
+the value will be emitted as `sourceRoot` in the source map information
diff --git a/docs/build-binary-config.md b/docs/build-binary-config.md
@@ -0,0 +1,21 @@
+# Binary configuration parameters
+
+node-sass supports different configuration parameters to change settings related to the sass binary such as binary name, binary path or alternative download path. Following parameters are supported by node-sass:
+
+Variable name    | .npmrc parameter | Process argument   | Value
+-----------------|------------------|--------------------|------
+SASS_BINARY_NAME | sass_binary_name | --sass-binary-name | path
+SASS_BINARY_SITE | sass_binary_site | --sass-binary-site | URL
+SASS_BINARY_PATH | sass_binary_path | --sass-binary-path | path
+
+These parameters can be used as environment variable:
+
+* E.g. `export SASS_BINARY_SITE=http://example.com/`
+
+As local or global [.npmrc](https://docs.npmjs.com/misc/config) configuration file:
+
+* E.g. `sass_binary_site=http://example.com/`
+
+As a process argument:
+
+* E.g. `npm install node-sass --SASS_BINARY_SITE=http://example.com/`
diff --git a/docs/build-post-install-test.md b/docs/build-post-install-test.md
@@ -0,0 +1,3 @@
+# Post-install Build
+
+Install runs only two Mocha tests to see if your machine can use the pre-built [LibSass] which will save some time during install. If any tests fail it will build from source.
diff --git a/docs/build-rebuild-binaries.md b/docs/build-rebuild-binaries.md
@@ -0,0 +1,15 @@
+# Rebuilding binaries
+
+Node-sass includes pre-compiled binaries for popular platforms, to add a binary for your platform follow these steps:
+
+Check out the project:
+
+```bash
+git clone --recursive https://github.com/sass/node-sass.git
+cd node-sass
+git submodule update --init --recursive
+npm install
+node scripts/build -f  # use -d switch for debug release
+# if succeeded, it will generate and move
+# the binary in vendor directory.
+```
diff --git a/docs/cli.md b/docs/cli.md
diff --git a/docs/integrations.md b/docs/integrations.md
