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
oryarn create
without having to install any dependencies. Running the followingnpx
command installs the latest version into a folder callednew-site
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 resultingnode_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 likehtml5-boilerplate_v9.0.0
. From the command-line, you will need to create a folder and unzip the contents into that folder.
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.
- Includes:
- Placeholder Open Graph elements and attributes.
- An example package.json file with WebPack commands built 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.
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.