add html boilerplate
[tools.git] / doc / js.md
Maxious 1 [HTML5 Boilerplate homepage](http://html5boilerplate.com) | [Documentation
2 table of contents](README.md)
3
4 # The JavaScript
5
6 Information about the default JavaScript included in the project.
7
8 ## main.js
9
10 This file can be used to contain or reference your site/app JavaScript code.
11 For larger projects, you can make use of a JavaScript module loader, like
12 [Require.js](http://requirejs.org/), to load any other scripts you need to
13 run.
14
15 ## plugins.js
16
17 This file can be used to contain all your plugins, such as jQuery plugins and
18 other 3rd party scripts.
19
20 One approach is to put jQuery plugins inside of a `(function($){ ...
21 })(jQuery);` closure to make sure they're in the jQuery namespace safety
22 blanket. Read more about [jQuery plugin
23 authoring](http://docs.jquery.com/Plugins/Authoring#Getting_Started)
24
25 ## vendor
26
27 This directory can be used to contain all 3rd party library code.
28
29 Minified versions of the latest jQuery and Modernizr libraries are included by
30 default. You may wish to create your own [custom Modernizr
31 build](http://www.modernizr.com/download/).
32