mirror of
https://github.com/h5bp/html5-boilerplate.git
synced 2026-01-09 22:58:12 -05:00
Update README.md
This commit is contained in:
30
README.md
30
README.md
@@ -13,9 +13,9 @@ 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: [https://html5boilerplate.com/](https://html5boilerplate.com/)
|
||||
* Source: [https://github.com/h5bp/html5-boilerplate](https://github.com/h5bp/html5-boilerplate)
|
||||
* Twitter: [@h5bp](https://twitter.com/h5bp)
|
||||
* [Homepage](https://html5boilerplate.com/)
|
||||
* [Source Code](https://github.com/h5bp/html5-boilerplate)
|
||||
* [Twitter(@h5pb)](https://twitter.com/h5bp)
|
||||
|
||||
## About This Repository
|
||||
|
||||
@@ -34,11 +34,11 @@ site or app based on HTML5 Boilerplate.
|
||||
|
||||
So, if you're looking for a quick start template to build a web site or
|
||||
application, look at the options in the
|
||||
[Quick Start section of this document](https://github.com/h5bp/html5-boilerplate#quick-start)
|
||||
[Quick Start](https://github.com/h5bp/html5-boilerplate#quick-start) section of this document.
|
||||
|
||||
If you want to help us _improve_ HTML5 Boilerplate then you can start with the documentation [here](.github/CONTRIBUTING.md), which includes steps to clone this repo in order to get it set up for development.
|
||||
|
||||
## Quick start
|
||||
## Quick Start
|
||||
|
||||
Choose one of the following options:
|
||||
|
||||
@@ -68,10 +68,10 @@ Choose one of the following options:
|
||||
|
||||
|
||||
* Download the latest stable release from
|
||||
[html5boilerplate.com](https://html5boilerplate.com/). This zip file is a
|
||||
[here](https://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
|
||||
`html5-boilerplate_v7.3.0`. From the command-line, you will need to create a
|
||||
folder and unzip the contents into that folder.
|
||||
|
||||
```bash
|
||||
@@ -81,19 +81,19 @@ Choose one of the following options:
|
||||
|
||||
## Features
|
||||
|
||||
* A finely-tuned starter template. Reap the benefits of 10 years of analysis,
|
||||
* 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:
|
||||
* [`Normalize.css`](https://necolas.github.io/normalize.css/)
|
||||
for CSS normalizations and common bug fixes
|
||||
for CSS normalizations and common bug fixes.
|
||||
* A custom build of [`Modernizr`](https://modernizr.com/) for feature
|
||||
detection
|
||||
detection.
|
||||
* [`Apache Server Configs`](https://github.com/h5bp/server-configs-apache)
|
||||
that improve the web site's performance and security
|
||||
that improve the web site's performance and security.
|
||||
* Placeholder Open Graph elements and attributes.
|
||||
* An example package.json file with [WebPack](https://webpack.js.org/) commands
|
||||
built in to jumpstart application development
|
||||
built in to jumpstart application development.
|
||||
* Placeholder CSS Media Queries.
|
||||
* Useful CSS helper classes.
|
||||
* Default print styles, performance optimized.
|
||||
@@ -102,7 +102,7 @@ Choose one of the following options:
|
||||
* "Delete-key friendly." Easy to strip out parts you don't need.
|
||||
* Extensive documentation.
|
||||
|
||||
## Browser support
|
||||
## Browser Support
|
||||
|
||||
HTML5-Boilerplate supports the latest, stable releases of all major browsers.
|
||||
|
||||
@@ -118,7 +118,7 @@ You can find our range of supported browsers in our [package.json](https://githu
|
||||
],
|
||||
```
|
||||
|
||||
[That configuration translates to this full list of browsers.](https://browserslist.dev/?q=ID4gMC41JSwgICAgIGxhc3QgMiB2ZXJzaW9ucywgICAgIEZpcmVmb3ggRVNSLCAgICBub3QgZGVhZCwgICAgIG5vdCBJRSAxMQ)
|
||||
That configuration translates to this [full list of browsers](https://browserslist.dev/?q=ID4gMC41JSwgICAgIGxhc3QgMiB2ZXJzaW9ucywgICAgIEZpcmVmb3ggRVNSLCAgICBub3QgZGVhZCwgICAgIG5vdCBJRSAxMQ).
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -130,7 +130,7 @@ write about your project.
|
||||
## Contributing
|
||||
|
||||
Hundreds of developers have helped to make the HTML5 Boilerplate. Anyone is
|
||||
welcome to [contribute](.github/CONTRIBUTING.md), however, if you decide to get
|
||||
welcome to [contribute](.github/CONTRIBUTING.md). However, if you decide to get
|
||||
involved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md):
|
||||
|
||||
* [Bug reports](.github/CONTRIBUTING.md#bugs)
|
||||
|
||||
Reference in New Issue
Block a user