README

HTML5 Boilerplate






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.

- Homepage
- Source Code

 About This Repository

This repository is where HTML5-Boilerplate is authored. Some of the tools,
files and processes that you see here are solely for the _production_ of
HTML5 Boilerplate and are not _part_ of HTML5 Boilerplate. For one example, the
gulpfile.mjs
script is used to _build_ 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 clone vuejs/core
to create a Vue.js app, you don't need to clone this repository to start a new
site or app based on HTML5 Boilerplate.

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

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

 Quick Start

Choose one of the following options:

- Using the create-html5-boilerplate
  script, 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

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

- Using our new Template Repository
  create a new GitHub repository based on the latest code from the main branch of HTML5
  Boilerplate.

- 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.

- Download the latest stable release from
  here. 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_v9.0.0. From the command-line, you will need to create a
  folder and unzip the contents into that folder.

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

 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.
- Include

Top issues

Discussions

Latest release

- Fixed tests on Windows, adds Windows Testing Action 3110
- Add og:image:alt for accessibility 3066
- Upgrade to Gulp 5 3100 3105
- ci: Use GITHUB_OUTPUT envvar instead of set-output command 3068
- Readme and Changelog updates 3055 3057 3064