diff --git a/README.md b/README.md index 7649b5dc4..d67b46a70 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Additionally, plugins make it possible to load ANY module type you might come up ## Extending `steal` with Plugins -The StealJS organization maintains popular plugins that extend and enhance the module-loading capablitities of `steal` (and, subsequently, `steal-tools`) such as: +The StealJS organization maintains popular plugins that extend and enhance the module-loading capabilities of `steal` (and, subsequently, `steal-tools`) such as: - [CSS](https://github.com/stealjs/steal-css) - [Less](https://github.com/stealjs/steal-less) diff --git a/docs/module-npm.md b/docs/module-npm.md index 5dca8de0a..f67595b4d 100644 --- a/docs/module-npm.md +++ b/docs/module-npm.md @@ -20,10 +20,10 @@ By default, if [config.stealPath] points to steal.js within node_modules like: [config.configMain] will point to `"package.json!npm"`. The `npm` plugin reads `package.json` and sets a normalize and locate hook. -**Note**: if you are using NPM 3 see the *npmAlgorithm* option below. +**Note**: if you are using npm 3 see the *npmAlgorithm* option below. -## NPM Module names +## npm Module names Package dependency module names are converted to look like: @@ -107,7 +107,7 @@ imported. This path that `my-main` will be found depends on the `directories.li ### package.steal.map The map config works similar to the base [config.map] behavior. However, both the keys and values -are converted to NPM module names. The keys and values must: +are converted to npm module names. The keys and values must: - Start with `./` to map modules within the package like `"./src/util"`, or - Look like `packageName#./modulePath` to map direct dependencies of the package. @@ -212,9 +212,9 @@ Even though `npmIgnore` is set to ignore all `devDependencies` the use of `npmDe Used to determine which algorithm is used to look up packages. -The default algorithm is `flat`. **We assume that you are using NPM 3 or higher.** See [here](https://github.com/npm/npm/releases/tag/v3.0.0) more about the flat file structure of NPM 3. +The default algorithm is `flat`. **We assume that you are using npm 3 or higher.** See [here](https://github.com/npm/npm/releases/tag/v3.0.0) more about the flat file structure of npm 3. -If you are using NPM 2 your dependencies of `node_modules` will be nested. StealJS can handle the lookup by setting `npmAlgorithm` to `nested`. +If you are using npm 2 your dependencies of `node_modules` will be nested. StealJS can handle the lookup by setting `npmAlgorithm` to `nested`. ```js { diff --git a/docs/module-steal-clone.md b/docs/module-steal-clone.md index 05c54a964..1b7e38d02 100644 --- a/docs/module-steal-clone.md +++ b/docs/module-steal-clone.md @@ -108,6 +108,6 @@ loader.import('moduleB').then(function(){ You will be able to override the value of `moduleB`. Note that for this to work you must import [@loader] to use for dynamic loading instead of using `steal.import`. This is because `@loader` will refer to the cloned loader you created where as `steal.loader` always refers back to the global loader. Using [@loader] is always recommended anyways. -### Use with Bower or NPM +### Use with Bower or npm -Steal-clone can be used to override dependencies from [Bower](http://stealjs.com/docs/bower.html) or [NPM](http://stealjs.com/docs/npm.html) in the same way as any other module. +Steal-clone can be used to override dependencies from [Bower](http://stealjs.com/docs/bower.html) or [npm](http://stealjs.com/docs/npm.html) in the same way as any other module. diff --git a/docs/pages/changelog.md b/docs/pages/changelog.md index f74b49f3a..aa91d1f75 100644 --- a/docs/pages/changelog.md +++ b/docs/pages/changelog.md @@ -66,7 +66,7 @@ ### steal -- Support added for [NPM 3](https://github.com/stealjs/steal/pull/522). +- Support added for [npm 3](https://github.com/stealjs/steal/pull/522). - Support added for [scoped packages](https://github.com/stealjs/system-npm/pull/78). ## 0.12.0 diff --git a/docs/pages/configuration.md b/docs/pages/configuration.md index 148c6c6e0..d4ae412b9 100644 --- a/docs/pages/configuration.md +++ b/docs/pages/configuration.md @@ -3,7 +3,7 @@ @body -Steal allows you to configure module loading through a **steal** property in your package.json. If you're not using Steal through NPM (you should be) you can also configure using any of the options provided by [config.config]. +Steal allows you to configure module loading through a **steal** property in your package.json. If you're not using Steal through npm (you should be) you can also configure using any of the options provided by [config.config]. A basic configuration might look like this: diff --git a/docs/pages/contributing.md b/docs/pages/contributing.md index 6cb94f8c0..911351907 100644 --- a/docs/pages/contributing.md +++ b/docs/pages/contributing.md @@ -278,7 +278,7 @@ website. To edit the docs: > git clone https://github.com/stealjs/stealjs.git -3. Install NPM dependencies: +3. Install npm dependencies: > npm install diff --git a/docs/pages/migrating.md b/docs/pages/migrating.md index 5240b1168..f7c6885c2 100644 --- a/docs/pages/migrating.md +++ b/docs/pages/migrating.md @@ -58,7 +58,7 @@ The old Steal was chainable using `.then`, but this produced numerous problems t The old Steal always produced a `production.js` file, but this is no longer the case. Though configurable, by default the new Steal will place the production file in `dist/bundles` and it will be named after your main module. -You will also need to add the following to your `stealconfig.js` file to be able to build the CanJS projects (note if you are using NPM this isn't necessary): +You will also need to add the following to your `stealconfig.js` file to be able to build the CanJS projects (note if you are using npm this isn't necessary): ```js steal.config({ diff --git a/docs/pages/project-exporting.md b/docs/pages/project-exporting.md index f5319d252..63955e0ea 100644 --- a/docs/pages/project-exporting.md +++ b/docs/pages/project-exporting.md @@ -5,7 +5,7 @@ StealJS can export your project into commonly used formats and platforms which can be used to create distributables that can be used in almost any situation: - [syntax.amd] and Bower - - [syntax.CommonJS] and NPM for [Browserify](http://browserify.org/) + - [syntax.CommonJS] and npm for [Browserify](http://browserify.org/) - [syntax.es6 ES Syntax] and StealJS, SystemJS, or JSPM - [syntax.global global format] and ` -StealJS will know that you're using NPM and look up your package.json for metadata. For you it's as simple as saving and then using: +StealJS will know that you're using npm and look up your package.json for metadata. For you it's as simple as saving and then using: import THREE from "three"; diff --git a/docs/steal.md b/docs/steal.md index 8880758ef..24819e16b 100644 --- a/docs/steal.md +++ b/docs/steal.md @@ -23,11 +23,11 @@ There are four basic steps when using Steal: Steal works slightly differently depending on how it is installed. There are three ways to install Steal: - - [npm](#section_NPMbasics) + - [npm](#section_npmbasics) - [bower](#section_Bowerbasics) - [download](#section_Downloadbasics) -## NPM basics +## npm basics The following details how to use steal installed via [npm](https://www.npmjs.com/) to make a simple jQuery app. @@ -100,7 +100,7 @@ $("body").append("