Repository files navigation

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

This project is the product of over 10 years of iterative development andcommunity knowledge. It does not impose a specific developmentphilosophy or framework, so you're free to architect your code in theway that you want.

• Homepage
• Source Code

This repository is where HTML5-Boilerplate is authored. Some of the tools,files and processes that you see here are solely for theproduction ofHTML5 Boilerplate and are notpart of HTML5 Boilerplate. For one example, thegulpfile.mjsscript is used tobuild the project. It's not part of the project itself.

The project we publish is represented by the contents of the/dist/folder. Everything else in this repository is used to author the project.

Think of it this way, in the same way that you don't clonevuejs/coreto create a Vue.js app, you don't need to clone this repository to start a newsite or app based on HTML5 Boilerplate.

So, if you're looking for a quick start template to build a website orapplication, look at the options in theQuick Start section of this document.

If you want to help usimprove HTML5 Boilerplate then you can start with the documentationhere, which includes steps to clone this repo in order to get it set up for development.

Choose one of the following options:

• Using thecreate-html5-boilerplatescript, instantly fetch the latest npm published package (or any versionavailable on npm) withnpx,npm init oryarn create without having toinstall any dependencies. Running the followingnpx command installs thelatest version into a folder callednew-site

  npx create-html5-boilerplate new-sitecd new-sitenpm installnpm run start

• Using our newTemplate Repositorycreate a new GitHub repository based on the latest code from the main branch of HTML5Boilerplate.

• Install withnpm:npm install html5-boilerplateoryarn:yarn add html5-boilerplate. The resultingnode_modules/html5-boilerplate/dist folder represents the latest version ofthe project for end users. Depending on what you want to use and how you wantto use it, you may have to copy and paste the contents of that folder intoyour project directory.

• Download the latest stable release fromhere. This zip file is asnapshot of thedist folder. On Windows, Mac and from the file manager onLinux unzipping this folder will output to a folder named something likehtml5-boilerplate_v9.0.0. From the command-line, you will need to create afolder and unzip the contents into that folder.

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

• 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 withWebPack commandsbuilt in to jumpstart application development.
  • Placeholder CSS Media Queries.
  • Useful CSS helper classes.
  • Default print styles, performance optimized.
  • "Delete-key friendly." Easy to strip out parts you don't need.
  • Extensive documentation.

HTML5-Boilerplate supports the latest, stable releases of all major browsers.

Check thedefault configuration fromBrowserslistfor more details on browsers and versions covered.

Take a look at thedocumentation table of contents. Thisdocumentation is bundled with the project which makes it available for offlinereading and provides a useful starting point for any documentation you want towrite about your project.

Hundreds of developers have helped to make the HTML5 Boilerplate. Anyone iswelcome tocontribute. However, if you decide to getinvolved, please take a moment to review theguidelines:

• Bug reports
• Feature requests
• Pull requests

The code is available under theMIT license.