Add new documentation

This commit is contained in:
James Kyle
2015-01-05 23:27:46 -08:00
parent 92366dfc7b
commit 46f9ed7d74
24 changed files with 2198 additions and 1018 deletions

55
doc/usage/require.md Normal file
View File

@@ -0,0 +1,55 @@
---
layout: docs
title: Require Hook
description: How to use the require hook.
permalink: /docs/usage/require/
---
## Install
```sh
$ npm install 6to5
```
## Usage
```js
require('6to5/register');
```
All subsequent files required by node with the extensions `.es6`, `.es`, and
`.js` will be transformed by 6to5. The polyfill specified in Polyfill is also
required.
**NOTE:** By default all requires to `node_modules` will be ignored. You can
override this by passing an ignore regex via:
```js
require('6to5/register')({
// This will override `node_modules` ignoring - you can alternatively pass
// a regex
ignore: false
});
```
## Register Options
```javascript
require('6to5/register')({
// Optional ignore regex - if any filenames **do** match this regex then they
// aren't compiled
ignore: /regex/,
// Optional only regex - if any filenames **don't** match this regex then they
// aren't compiled
only: /my_es6_folder/,
// See options above for usage
whitelist: [],
blacklist: [],
// This will remove the currently hooked extensions of .es6 and .js so you'll
// have to add them back if you want them to be used again.
extensions: ['.js', '.es6']
});
```