2012-04-16 23:52:55 +02:00
|
|
|
# [HTML5 Boilerplate](http://html5boilerplate.com)
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2012-09-04 18:48:52 +02:00
|
|
|
HTML5 Boilerplate is a professional front-end template for building fast,
|
|
|
|
|
robust, and adaptable web apps or sites.
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2012-09-04 18:48:52 +02:00
|
|
|
This project is the product of many years of iterative development and combined
|
|
|
|
|
community knowledge. It does not impose a specific development philosophy or
|
|
|
|
|
framework, so you're free to architect your code in the way that you want.
|
|
|
|
|
|
|
|
|
|
* Source: [https://github.com/h5bp/html5-boilerplate](https://github.com/h5bp/html5-boilerplate)
|
|
|
|
|
* Homepage: [http://html5boilerplate.com](http://html5boilerplate.com)
|
|
|
|
|
* Twitter: [@h5bp](http://twitter.com/h5bp)
|
2011-08-22 10:15:55 +02:00
|
|
|
|
|
|
|
|
|
2012-04-16 23:52:55 +02:00
|
|
|
## Quick start
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2012-09-04 18:48:52 +02:00
|
|
|
Choose one of the following options:
|
|
|
|
|
|
|
|
|
|
1. Download the latest stable release from
|
|
|
|
|
[html5boilerplate.com](http://html5boilerplate.com/) or a custom build from
|
|
|
|
|
[Initializr](http://www.initializr.com).
|
|
|
|
|
2. Clone the git repo — `git clone
|
2014-04-12 21:17:38 +02:00
|
|
|
https://github.com/h5bp/html5-boilerplate.git` - and checkout the [tagged
|
|
|
|
|
release](https://github.com/h5bp/html5-boilerplate/releases) you'd like to
|
|
|
|
|
use.
|
2011-08-22 10:15:55 +02:00
|
|
|
|
|
|
|
|
|
2012-04-16 23:52:55 +02:00
|
|
|
## Features
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2012-04-16 23:52:55 +02:00
|
|
|
* HTML5 ready. Use the new elements with confidence.
|
|
|
|
|
* Cross-browser compatible (Chrome, Opera, Safari, Firefox 3.6+, IE6+).
|
|
|
|
|
* Designed with progressive enhancement in mind.
|
2012-09-04 18:48:52 +02:00
|
|
|
* Includes [Normalize.css](http://necolas.github.com/normalize.css/) for CSS
|
|
|
|
|
normalizations and common bug fixes.
|
|
|
|
|
* The latest [jQuery](http://jquery.com/) via CDN, with a local fallback.
|
|
|
|
|
* The latest [Modernizr](http://modernizr.com/) build for feature detection.
|
2012-04-16 23:52:55 +02:00
|
|
|
* IE-specific classes for easier cross-browser control.
|
2012-09-04 18:48:52 +02:00
|
|
|
* Placeholder CSS Media Queries.
|
|
|
|
|
* Useful CSS helpers.
|
|
|
|
|
* Default print CSS, performance optimized.
|
|
|
|
|
* Protection against any stray `console.log` causing JavaScript errors in
|
|
|
|
|
IE6/7.
|
2012-04-16 23:52:55 +02:00
|
|
|
* An optimized Google Analytics snippet.
|
2012-09-04 18:48:52 +02:00
|
|
|
* Apache server caching, compression, and other configuration defaults for
|
|
|
|
|
Grade-A performance.
|
2012-04-16 23:52:55 +02:00
|
|
|
* Cross-domain Ajax and Flash.
|
|
|
|
|
* "Delete-key friendly." Easy to strip out parts you don't need.
|
|
|
|
|
* Extensive inline and accompanying documentation.
|
2011-08-22 10:15:55 +02:00
|
|
|
|
|
|
|
|
|
2012-09-04 18:48:52 +02:00
|
|
|
## Documentation
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2014-04-12 21:17:38 +02:00
|
|
|
Take a look at the [documentation table of contents](doc/TOC.md). This
|
2012-09-04 18:48:52 +02:00
|
|
|
documentation is bundled with the project, which makes it readily available for
|
2014-04-12 21:17:38 +02:00
|
|
|
offline reading and provides a useful starting point for any documentation you
|
|
|
|
|
want to write about your project.
|
2011-08-22 10:15:55 +02:00
|
|
|
|
|
|
|
|
|
2012-09-04 18:48:52 +02:00
|
|
|
## Contributing
|
2011-08-22 10:15:55 +02:00
|
|
|
|
2014-04-12 21:17:38 +02:00
|
|
|
Anyone and everyone is welcome to [contribute](CONTRIBUTING.md). Hundreds of
|
|
|
|
|
developers have helped make the HTML5 Boilerplate what it is today.
|
