Skip to content

Latest commit

 

History

History
121 lines (96 loc) · 5.23 KB

README.md

File metadata and controls

121 lines (96 loc) · 5.23 KB
Raw

HTML5 Boilerplate

Build status LICENSE NPM Downloads github-stars-image

HTML5 Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.

This project is the product of over 10 years of iterative development and 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.

Quick start

Choose one of the following options:

  • Download the latest stable release from html5boilerplate.com. This zip file is a snapshot of the dist folder. On Windows, Mac and from the file manager on Linux unzipping this folder will output to a folder named something like html5-boilerplate_v7.3.0. From the command line will need to create a folder and unzip the contents into that folder.

    mkdir html5-boilerplate
unzip html5-boilerplate*.zip -d html5-boilerplate

  • Clone the git repo — git clone https://github.com/h5bp/html5-boilerplate.git - and checkout the tagged release you'd like to use. The dist folder represents the latest version of the project for end users.

  • Install with npm: npm install html5-boilerplate or yarn: yarn add html5-boilerplate. The resulting node_modules/html5-boilerplate/dist folder represents the latest version of the project for end users. Depending on what you want to use and how you want to use it, you may have to copy and paste the contents of that folder into your project directory.

  • Using our new create-html5-boilerplate project, instantly fetch the latest npm published package (or any version available on npm) with npx, npm init or yarn create without having to install any dependencies. Running the following npx command installs the latest version into a folder called new-site

    npx create-html5-boilerplate new-site
cd new-site
npm install
npm start

Features

  • A finely-tuned starter template. Reap the benefits of 10 years of analysis, research and experimentation by over 200 contributors.
  • Designed with progressive enhancement in mind.
  • Includes:
  • Placeholder Open Graph elements and attributes.
  • An example package.json file with Parcel commands built in to jumpstart application development
  • Placeholder CSS Media Queries.
  • 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.
  • "Delete-key friendly." Easy to strip out parts you don't need.
  • Extensive documentation.

Browser support

  • Chrome (latest 2)
  • Edge (latest 2)
  • Firefox (latest 2)
  • Internet Explorer 11
  • 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 you can use HTML5 Boilerplate v6 (IE9/IE10) or HTML5 Boilerplate v5 (IE 8). They are no longer actively developed.

Documentation

Take a look at the documentation table of contents. This documentation is bundled with the project which makes it available for offline reading and provides a useful starting point for any documentation you want to write about your project.

Contributing

Hundreds of developers have helped to make the HTML5 Boilerplate. Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:

License

The code is available under the MIT license.