2015-08-30 19:52:32 +02:00
|
|
|
# [HTML5 Boilerplate](https://html5boilerplate.com)
|
2014-07-31 18:00:20 +02:00
|
|
|
|
2015-02-04 16:08:32 +01:00
|
|
|
[](https://travis-ci.org/h5bp/html5-boilerplate)
|
|
|
|
|
[](https://david-dm.org/h5bp/html5-boilerplate#info=devDependencies)
|
|
|
|
|
|
2015-08-30 19:52:32 +02:00
|
|
|
HTML5 Boilerplate is a professional front-end template for building
|
|
|
|
|
fast, robust, and adaptable web apps or sites.
|
2014-07-31 18:00:20 +02:00
|
|
|
|
2015-08-30 19:52:32 +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.
|
2014-07-31 18:00:20 +02:00
|
|
|
|
2015-08-30 19:52:32 +02:00
|
|
|
* Homepage: [https://html5boilerplate.com](https://html5boilerplate.com)
|
2014-07-31 18:00:20 +02:00
|
|
|
* Source: [https://github.com/h5bp/html5-boilerplate](https://github.com/h5bp/html5-boilerplate)
|
2015-02-04 16:08:32 +01:00
|
|
|
* Twitter: [@h5bp](https://twitter.com/h5bp)
|
2014-07-31 18:00:20 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Quick start
|
|
|
|
|
|
|
|
|
|
Choose one of the following options:
|
|
|
|
|
|
|
|
|
|
1. Download the latest stable release from
|
2015-08-30 19:52:32 +02:00
|
|
|
[html5boilerplate.com](https://html5boilerplate.com/) or create a
|
|
|
|
|
custom build using [Initializr](http://www.initializr.com).
|
2014-07-31 18:00:20 +02:00
|
|
|
2. Clone the git repo — `git clone
|
2015-08-30 19:52:32 +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.
|
2014-07-31 18:00:20 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* HTML5 ready. Use the new elements with confidence.
|
|
|
|
|
* Designed with progressive enhancement in mind.
|
2015-08-30 19:52:32 +02:00
|
|
|
* Includes:
|
|
|
|
|
* [`Normalize.css`](https://necolas.github.com/normalize.css/)
|
|
|
|
|
for CSS normalizations and common bug fixes
|
|
|
|
|
* [`jQuery`](https://jquery.com/) via CDN, with a local fallback
|
|
|
|
|
* A custom build of [`Modernizr`](http://modernizr.com/) for feature
|
|
|
|
|
detection
|
|
|
|
|
* [`Apache Server Configs`](https://github.com/h5bp/server-configs-apache)
|
|
|
|
|
that, among other, improve the web site's performance and security
|
2014-07-31 18:00:20 +02:00
|
|
|
* Placeholder CSS Media Queries.
|
2015-08-30 19:52:32 +02:00
|
|
|
* Useful CSS helper classes.
|
|
|
|
|
* Default print styles, performance optimized.
|
|
|
|
|
* An optimized version of the Google Universal Analytics snippet.
|
|
|
|
|
* Protection against any stray `console` statements causing JavaScript
|
|
|
|
|
errors in older browsers.
|
2014-07-31 18:00:20 +02:00
|
|
|
* "Delete-key friendly." Easy to strip out parts you don't need.
|
|
|
|
|
* Extensive inline and accompanying documentation.
|
|
|
|
|
|
2015-08-30 19:52:32 +02:00
|
|
|
|
|
|
|
|
## Browser support
|
|
|
|
|
|
|
|
|
|
* Chrome *(latest 2)*
|
2016-08-09 15:32:12 +02:00
|
|
|
* Edge *(latest 2)*
|
2015-08-30 19:52:32 +02:00
|
|
|
* Firefox *(latest 2)*
|
|
|
|
|
* Internet Explorer 8+
|
|
|
|
|
* Opera *(latest 2)*
|
|
|
|
|
* Safari *(latest 2)*
|
|
|
|
|
|
|
|
|
|
*This doesn't mean that HTML5 Boilerplate cannot be used in older browsers,
|
|
|
|
|
just that we'll ensure compatibility with the ones mentioned above.*
|
|
|
|
|
|
|
|
|
|
If you need legacy browser support (IE 6+, Firefox 3.6+, Safari 4+) you
|
|
|
|
|
can use [HTML5 Boilerplate v4](https://github.com/h5bp/html5-boilerplate/tree/v4),
|
|
|
|
|
but is no longer actively developed.
|
|
|
|
|
|
2014-07-31 18:00:20 +02:00
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
2015-08-30 19:52:32 +02:00
|
|
|
Take a look at the [documentation table of contents](dist/doc/TOC.md).
|
|
|
|
|
This documentation is bundled with the project, which makes it readily
|
|
|
|
|
available for offline reading and provides a useful starting point for
|
|
|
|
|
any documentation you want to write about your project.
|
2014-07-31 18:00:20 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
2015-08-30 19:52:32 +02:00
|
|
|
Hundreds of developers have helped make the HTML5 Boilerplate what it is
|
|
|
|
|
today. Anyone and everyone is welcome to [contribute](CONTRIBUTING.md),
|
|
|
|
|
however, if you decide to get involved, please take a moment to review
|
|
|
|
|
the [guidelines](CONTRIBUTING.md):
|
|
|
|
|
|
|
|
|
|
* [Bug reports](CONTRIBUTING.md#bugs)
|
|
|
|
|
* [Feature requests](CONTRIBUTING.md#features)
|
|
|
|
|
* [Pull requests](CONTRIBUTING.md#pull-requests)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
The code is available under the [MIT license](LICENSE.txt).
|
