Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 89 lines (51 sloc) 2.762 kb
a608d33 @davglass Initial Import
authored
1 h1. YUI Bootstrapper for Node.js
2
fb021b7 @davglass README Updates
authored
3 The YUI3NodeJS project uses several 3rd party open source libraries and tools.
96cb880 @davglass README Updates
authored
4
5 This file summarizes the tools used, their purpose, and the licenses under which they're released.
6
a608d33 @davglass Initial Import
authored
7 This node.js module attempts to setup and bootstrap a working YUI 3 instance.
8
45e90aa @davglass Updated README with new IO calls
authored
9 This module includes support for remote script loading via Y.Get.script() and remote data fetching via Y.io.
a608d33 @davglass Initial Import
authored
10
04778c4 @davglass Moved around source and examples
authored
11 See "JSDom Support" below for DOM manipulation.
12
13 h2. Node.js
14
d06e29f @davglass README Updates
authored
15 All of the examples and tests assume you have @node@ in your path and they are all executable.
a608d33 @davglass Initial Import
authored
16
2f5f618 @davglass Added deps to README
authored
17 h2. Dependancies
18
96cb880 @davglass README Updates
authored
19 "JSDom":http://github.com/tmpvar/jsdom : "LICENSE":http://github.com/tmpvar/jsdom/blob/master/LICENSE.txt
20 "HTML Parser":http://github.com/tautologistics/node-htmlparser : "LICENSE":http://github.com/tautologistics/node-htmlparser/blob/master/LICENSE
5c83119 @davglass Updated README and removed submodule
authored
21
62c75ff @davglass README updated
authored
22 h2. Installing - via NPM
a608d33 @davglass Initial Import
authored
23
62c75ff @davglass README updated
authored
24 <pre class="console">
25 npm install yui3
26 </pre>
a608d33 @davglass Initial Import
authored
27
62c75ff @davglass README updated
authored
28 h2. Installing - as a developer
bc5be79 @davglass Updated README
authored
29
30 <pre class="console">
62c75ff @davglass README updated
authored
31 git clone git://github.com/davglass/nodejs-yui3.git
32 make dev
8db703f @davglass Finishing up some docs - npm published
authored
33 make install
bc5be79 @davglass Updated README
authored
34 </pre>
a608d33 @davglass Initial Import
authored
35
8db703f @davglass Finishing up some docs - npm published
authored
36 h2. Using YUI3
37
38 "This is the general-dom example":http://gist.github.com/541501
39
40
c4facb3 @davglass Added Y Browser example
authored
41 h2. Using the Y.Browser object
42
43 To comply with the "no-globals" CommonJS spec, there is no global document or window in this mode.
44 Just including the nodejs-dom module will create a fake dom for this instance.
45 You can create a document like this:
d06e29f @davglass README Updates
authored
46 "View this Gist":http://gist.github.com/359776
47
48 You can make older DOM code run by setting up a couple of local variables, "like this":http://gist.github.com/359778
c4facb3 @davglass Added Y Browser example
authored
49
50
51 If you are using YUI to serve pages, you should use a Nested Use to create the document when the request comes in.
52
d06e29f @davglass README Updates
authored
53 "Something like this":http://gist.github.com/359781
c4facb3 @davglass Added Y Browser example
authored
54
55
3923dca @davglass README updates
authored
56 I have an example showing this: @examples/y-browser.js@
c4facb3 @davglass Added Y Browser example
authored
57
58
04778c4 @davglass Moved around source and examples
authored
59 h2. Examples
a608d33 @davglass Initial Import
authored
60
61 <pre class="console">
04778c4 @davglass Moved around source and examples
authored
62 cd examples/
63 ./general-dom.js
64 ./io.js
65 ./library.js
3923dca @davglass README updates
authored
66 ./y-brower.js
a608d33 @davglass Initial Import
authored
67 </pre>
68
04778c4 @davglass Moved around source and examples
authored
69 h2. Tests
70
71 When using JSDom, All relevent YUI 3 Dom & Selector tests pass. The ones that are skipped revolve around styles and postioning. Since there is no window or CSS cascade, these seem unimportant at the moment.
a608d33 @davglass Initial Import
authored
72
73 <pre class="console">
04778c4 @davglass Moved around source and examples
authored
74 cd ./tests/
75 ./dom.js
76 ./selector.js
a608d33 @davglass Initial Import
authored
77 </pre>
78
96cb880 @davglass README Updates
authored
79
80 h2. License
81
82 This software is offered under the terms of the BSD license. See the LICENSE file or the "YUI License":http://developer.yahoo.com/yui/license.html for license text and copyright information.
83
84 h2. Contribute
85
86 Your contributions are welcome! Please review the "YUI contributor guide":http://developer.yahoo.com/yui/community/#cla before contributing. If you haven't contributed to a "YUI project":http://yuilibrary.com before, you'll need to review and sign the "YUI CLA":http://developer.yahoo.com/yui/community/#cla before we can accept your pull request.
87
88
Something went wrong with that request. Please try again.