html5-boilerplate README

The project's README from github.com/h5bp/html5-boilerplate. As one markdown file: README.md.

HTML5 Boilerplate

Build status LICENSE NPM Downloads GitHub Stars

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.

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:

Features

Browser Support

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

Check the default configuration from Browserslist for more details on browsers and versions covered.

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.

html5-boilerplate (h5bp/html5-boilerplate)

Searching Database…

Что это?HTML5 Boilerplate — профессиональный шаблон фронтенда для создания быстрых, надёжных и адаптируемых веб-приложений и сайтов. Его более 10 лет дорабатывают более 200 участников.
Это фреймворк, которому нужно следовать, или просто отправная точка?Это не фреймворк, и он не навязывает никакой философии разработки. Это стартовый шаблон из файлов-заглушек и конфигураций, которые вы адаптируете или удаляете по мере необходимости.
Как начать новый проект с его помощью?Используйте скрипт create-html5-boilerplate через npx, npm init или yarn create, чтобы мгновенно создать папку проекта. Также можно воспользоваться GitHub Template Repository, установить пакет через npm или yarn либо скачать zip-архив последнего релиза папки dist.
Нужны ли мне Node или какие-либо инструменты сборки, чтобы им пользоваться?Для использования готового результата никакие инструменты сборки не нужны: опубликованный проект — это просто статическое содержимое папки /dist/. Однако для участия в разработке самого репозитория нужны Node (в engines указан Node >=22) и gulp для сборки.
Нужно ли клонировать весь этот репозиторий, чтобы начать сайт?Нет. Этот репозиторий предназначен только для разработки и сборки самого шаблона. Конечным пользователям стоит выбрать один из вариантов Quick Start, а не клонировать его.
Работает ли он в старых или необычных браузерах?Поддерживаются последние стабильные версии всех основных браузеров. Это определяется конфигурацией Browserslist, включённой в проект.
Что входит в шаблон сразу после установки?В комплекте есть заглушки мета-тегов Open Graph, пример package.json с командами Webpack, заглушки CSS-медиазапросов, полезные CSS-классы-помощники и стили печати по умолчанию, оптимизированные по производительности.
Легко ли убрать ненужные части?Да. В README это описано как 'delete-key friendly', то есть неиспользуемые части можно легко удалить.
Creator
h5bp
Size
22.3 MB
Stars
57.7K
Age
16y
Commits · 90 Days