For building the compiled library and API documentation, we use a custom build script written in node.js. It uses the following libraries:
Google Closure requires that Java is installed on the system.
View the YUI Doc page for more information.
Google Closure is included in the repository, which makes it easier to run the build, and ensures that we don’t have version mismatches between the source and the libraries.
Note For PC users, please ensure that you have java installed on your machine. If not, go to http://www.java.com/ > Click: Free Java Download > Agree and Start Free Download.
For compression of the documentation for Windows, we have provided 7-zip.exe found within the /tools directory.
Note Run the installer(7z920.exe) and ensure the install destination is within tools sub-directory (ie. C:\build\tools\7-Zip).
7-Zip is licensed under the GNU LGPL license, For more information please visit http://www.7-zip.org/
In order to run the script, you must have node.js installed (tested v0.8.16+), along with the wrench and optimist modules and finally yuidocs
Once you have installed “node.js” the easiest way to install the required modules is to run the following through command line (Terminal / CMD):
Note To avoid problems while running script we would recommended installing (wrench/optimist/yuidoc) to the parent directory of your project, or on your root directory.
npm install wrench
npm install optimist
npm -g install yuidocjs
Build Task Manager
Usage
node ./build.js [-h] [-l] --tasks=TASK [--version=DOC_VERSION][--format=STANDARD]
Options:
-l, --list List all available tasks [boolean]
-h, --help Display usage [boolean]
--version Build version number (x.x.x) [string] [default:"NEXT"]
--tasks Task to run options: [ALL, CLEAN, BUILDSOURCE, BUILDDOCS] [default: "ALL"]
--format Formatting minified JS :[STANDARD, PRETTY_PRINT] [string] [default: "STANDARD"]
node ./build.js --tasks=ALL --version=0.5.0
node ./build.js --tasks=BUILDSOURCE
node ./build.js --tasks=BUILDDOCS --version=0.5.0
node ./build.js --tasks=CLEAN
node ./build.js --format=PRETTY_PRINT
There is a good reference on tagging at