AtHeartEngineer/html5-boilerplate
1
1
Fork 0
mirror of https://github.com/h5bp/html5-boilerplate.git synced 2026-01-09 16:08:01 -05:00
Code Issues Packages Projects Releases Wiki Activity

finishing up docs

Browse Source
This commit is contained in:
Rob Larsen
2020-05-29 15:28:52 -04:00
parent fa9a016eef
commit 4a8d981273
5 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -50,7 +50,7 @@ Choose one of the following options:
* Using our new [create-html5-boilerplate](https://github.com/h5bp/create-html5-boilerplate)
project, instantly fetch the latest npm published package (or any version
available on npm) with `npx`, `npm init` or `yarn create` withut having to
install any dependencies. Running the following `npx` command installs the
install any dependencies. Running the following `npx` command installs the
latest version into a folder called `new-site`
```
@@ -63,7 +63,7 @@ Choose one of the following options:
## Features
* A finely-tuned starter template. Reap the benefits of 10 years of analysis
and experimentation by over 200 contributors.
research and experimentation by over 200 contributors.
* Designed with progressive enhancement in mind.
* Includes:
* [`Normalize.css`](https://necolas.github.com/normalize.css/)
@@ -102,16 +102,16 @@ or [HTML5 Boilerplate v5](https://github.com/h5bp/html5-boilerplate/releases/tag
## Documentation
Take a look at the [documentation table of contents](dist/doc/TOC.md).
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.
Take a look at the [documentation table of contents](dist/doc/TOC.md). 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](.github/CONTRIBUTING.md), however, if you decide to
get involved, please take a moment to review the [guidelines](.github/CONTRIBUTING.md):
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)
* [Feature requests](.github/CONTRIBUTING.md#features)

4
dist/doc/html.md vendored
View File

@@ -205,7 +205,7 @@ to the `index.html` manually.
To load jQuery from a CDN with a local fallback you can use the following:
``` html
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" crossorigin="anonymous"></script>
<script>window.jQuery || document.write('<script src="js/vendor/jquery-3.5.1.min.js"><\/script>')</script>
```
@@ -218,7 +218,7 @@ We use `analytics.js` rather than the newer `gtag.js` as [it's faster and
supports tasks and
plugins](https://github.com/philipwalton/analyticsjs-boilerplate/issues/19#issuecomment-333714370)
Starting with version 8 we, by default, [anonymize IP
Starting with version 8.0.0 we, by default, [anonymize IP
addresses](href="https://support.google.com/analytics/answer/2763052?hl=en). By
default Google Analytics records the full IP address of a user visiting the
site, but that full IP address is never available to the Google Analytics

16
dist/doc/misc.md vendored
View File

@@ -174,18 +174,18 @@ see [MSDN](https://docs.microsoft.com/previous-versions/windows/internet-explore
use in modern JavaScript development. [The full documentation is available](https://docs.npmjs.com/files/package.json)
if you're interested. The fields we provide are as follows:
* `title` - the title of your site. If you expect to publish your application
* `title` - the title of your project. If you expect to publish your application
to npm, then the name needs to follow [certain guidelines](https://docs.npmjs.com/files/package.json#name)
and be unique.
* `version` - indicates the version of your application using semantic
* `version` - indicates the version of your site application using semantic
versioning ([semver](https://docs.npmjs.com/misc/semver))
* `description` - describes your site.
* `scripts` - is a JavaScript object containting commands that can be run in a
* `scripts` - is a JavaScript object containing commands that can be run in a
node environment. There are many [built-in keys](https://docs.npmjs.com/misc/scripts)
related to the pacakge lifecycle that node understands autoamtically. You can
related to the package lifecycle that node understands automatically. You can
also define custom scripts for use with your application development. We
provide three that work with Parcel to get you up and running quickly with a
bunlder for your assets and a simple development server.
provide three custom scripts that work with Parcel to get you up and running
quickly with a bundler for your assets and a simple development server.
* `start` builds your site and starts a server
* `build` builds your `index.html` using Parcel
@@ -198,7 +198,7 @@ if you're interested. The fields we provide are as follows:
field if there's more than one author.
* `license` - the license for your application. Must conform to
[specific rules](https://docs.npmjs.com/files/package.json#license)
* `devDependencies` - devevelopment dependencies for your package. In our case
it's a single dependency, Parcel, which we use to bundle files and run a
* `devDependencies` - development dependencies for your package. In our case
it's a single dependency, Parcel, which we use to bundle files and run a
simple web server.

4
src/doc/html.md
View File

@@ -205,7 +205,7 @@ to the `index.html` manually.
To load jQuery from a CDN with a local fallback you can use the following:
``` html
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.5.1.min.js" crossorigin="anonymous"></script>
<script>window.jQuery || document.write('<script src="js/vendor/jquery-3.5.1.min.js"><\/script>')</script>
```
@@ -218,7 +218,7 @@ We use `analytics.js` rather than the newer `gtag.js` as [it's faster and
supports tasks and
plugins](https://github.com/philipwalton/analyticsjs-boilerplate/issues/19#issuecomment-333714370)
Starting with version 8 we, by default, [anonymize IP
Starting with version 8.0.0 we, by default, [anonymize IP
addresses](href="https://support.google.com/analytics/answer/2763052?hl=en). By
default Google Analytics records the full IP address of a user visiting the
site, but that full IP address is never available to the Google Analytics

16
src/doc/misc.md
View File

@@ -174,18 +174,18 @@ see [MSDN](https://docs.microsoft.com/previous-versions/windows/internet-explore
use in modern JavaScript development. [The full documentation is available](https://docs.npmjs.com/files/package.json)
if you're interested. The fields we provide are as follows:
* `title` - the title of your site. If you expect to publish your application
* `title` - the title of your project. If you expect to publish your application
to npm, then the name needs to follow [certain guidelines](https://docs.npmjs.com/files/package.json#name)
and be unique.
* `version` - indicates the version of your application using semantic
* `version` - indicates the version of your site application using semantic
versioning ([semver](https://docs.npmjs.com/misc/semver))
* `description` - describes your site.
* `scripts` - is a JavaScript object containting commands that can be run in a
* `scripts` - is a JavaScript object containing commands that can be run in a
node environment. There are many [built-in keys](https://docs.npmjs.com/misc/scripts)
related to the pacakge lifecycle that node understands autoamtically. You can
related to the package lifecycle that node understands automatically. You can
also define custom scripts for use with your application development. We
provide three that work with Parcel to get you up and running quickly with a
bunlder for your assets and a simple development server.
provide three custom scripts that work with Parcel to get you up and running
quickly with a bundler for your assets and a simple development server.
* `start` builds your site and starts a server
* `build` builds your `index.html` using Parcel
@@ -198,7 +198,7 @@ if you're interested. The fields we provide are as follows:
field if there's more than one author.
* `license` - the license for your application. Must conform to
[specific rules](https://docs.npmjs.com/files/package.json#license)
* `devDependencies` - devevelopment dependencies for your package. In our case
it's a single dependency, Parcel, which we use to bundle files and run a
* `devDependencies` - development dependencies for your package. In our case
it's a single dependency, Parcel, which we use to bundle files and run a
simple web server.