-
Notifications
You must be signed in to change notification settings - Fork 204
Quick Start Guide
You must wrap any scripts to concatenate in a pair of specially constructed comments. These look like this:
legacy version (pre 1.0)
<!-- scripts concatenated and minified via build script -->
<script src="js/plugins.js"></script>
<script src="js/main.js"></script>
<!-- end scripts -->
1.0 and greater
<!-- //-beg- concat_js -->
<script src="js/plugins.js"></script>
<script src="js/main.js"></script>
<!-- //-end- concat_js -->
You've got all your dependencies pre-installed, likely. You need to install ant-contrib to get the build script working.
On Linux use
- Red Hat:
yum install ant-contrib
. - Debian/Ubuntu
aptitude install ant-contrib
orapt-get install ant-contrib
On Mac, install MacPorts and then do sudo port install ant-contrib
.
- Get the Java JDK (JRE isn't enough).
- Get WinAnt and point the installer to
Program Files/Java/jre6/bin/
- For detailed information on installing Ant for Windows, see this step-by-step command line instruction by Nicholas Zakas or our own point and click version-complete with screen shots
-
- Mac users, open the application "Terminal". Windows users, open command line interface by doing Start Menu > Run >
cmd.exe
. However, Windows users, we created a friendlyrunbuildscript.bat
file for you if you'd like to avoid the command line and navigate to the build directory within your project.
- Mac users, open the application "Terminal". Windows users, open command line interface by doing Start Menu > Run >
For those of you new to terminal or command line, use the change directory command followed by the directory path. for example...
cd sites/your-site/build/
Note: To ensure you've navigated to the correct directory, you may want to now check the files within the current directory. Mac users can type "ls" in terminal. Windows users should type "dir" in command line. If the file list returned is what you were expecting, move to step 2. Otherwise, check the directory location in Finder or Windows Explorer and start over.
-
- Next, simply type:
ant build
The H5BP build script will begin to run and compress your files. At the very end you should see "BUILD SUCCESSFUL" followed by the total time it took to build.
-
- Now, look in your H5BP project folder and see that there is a newly created "publish" directory within your project. Inside, you will find your minified CSS, JS and along with duplicates of the files from your original directory. This new set of files within "publish" is your production code. The site should look and function the same in browser as it did before, but only now faster!
Note: If your new pages do not render in browser the same as they did before your ran the build script, visit the Troubleshooting section below.
There are a few different build options:
ant build # minor html optimizations (extra quotes removed). inline script/style minified (default)
ant buildkit # all html whitespace retained. inline script/style minified
ant basics # same as build minus the basic html minfication
ant minify # same as build plus full html minification
ant text # same as build but without image (png/jpg) optimizing
Your build will be added to the publish/
folder. BOOM! you're done.