mirror of
https://github.com/h5bp/html5-boilerplate.git
synced 2026-01-09 14:48:02 -05:00
Docs and docs and docs
I added some package.json stuff, took out some stuff that you'd have to be a web development trivia nerd to even know about anymore (I lived through it and I don't remember) and did some formatting. One more pass and extra 👀 on it and this will be good to go.
This commit is contained in:
7
dist/doc/css.md
vendored
7
dist/doc/css.md
vendored
@@ -8,12 +8,6 @@ HTML5 Boilerplate's CSS includes:
|
||||
* [Normalize.css](#normalizecss)
|
||||
* [main.css](#maincss)
|
||||
|
||||
This starting CSS does not rely on the presence of [conditional class
|
||||
names](https://www.paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/),
|
||||
or [Modernizr](https://modernizr.com/), and it is ready to use no matter what
|
||||
your development preferences happen to be.
|
||||
|
||||
|
||||
## Normalize.css
|
||||
|
||||
In order to make browsers render all elements more consistently and in line with
|
||||
@@ -32,7 +26,6 @@ As opposed to CSS resets, Normalize.css:
|
||||
For more information about Normalize.css, please refer to its [project
|
||||
page](https://necolas.github.io/normalize.css/).
|
||||
|
||||
|
||||
## main.css
|
||||
|
||||
Several base styles are included that build upon `Normalize.css`. These styles:
|
||||
|
||||
3
dist/doc/extend.md
vendored
3
dist/doc/extend.md
vendored
@@ -7,7 +7,6 @@ Here is some useful advice for how you can make your project with HTML5
|
||||
Boilerplate even better. We don't want to include it all by default, as not
|
||||
everything fits with everyone's needs.
|
||||
|
||||
|
||||
* [App Stores](#app-stores)
|
||||
* [DNS prefetching](#dns-prefetching)
|
||||
* [Google Universal Analytics](#google-universal-analytics)
|
||||
@@ -100,7 +99,6 @@ Microsoft Ajax Content Delivery Network:
|
||||
* https://dev.chromium.org/developers/design-documents/dns-prefetching
|
||||
* https://docs.microsoft.com/en-us/archive/blogs/ie/internet-explorer-9-network-performance-improvements
|
||||
|
||||
|
||||
## Google Universal Analytics
|
||||
|
||||
### More tracking settings
|
||||
@@ -120,7 +118,6 @@ and
|
||||
[Event](https://developers.google.com/analytics/devguides/collection/analyticsjs/events)
|
||||
Docs.
|
||||
|
||||
|
||||
### Track jQuery AJAX requests in Google Analytics
|
||||
|
||||
An article by @JangoSteve explains how to [track jQuery AJAX requests in Google
|
||||
|
||||
36
dist/doc/misc.md
vendored
36
dist/doc/misc.md
vendored
@@ -9,6 +9,7 @@ table of contents](TOC.md)
|
||||
* [robots.txt](#robotstxt)
|
||||
* [humans.txt](#humanstxt)
|
||||
* [browserconfig.xml](#browserconfigxml)
|
||||
* [package.json](#packagejson)
|
||||
|
||||
--
|
||||
|
||||
@@ -166,3 +167,38 @@ Notice that IE11 uses the same images when adding a site to the `favorites`.
|
||||
|
||||
For more in-depth information about the `browserconfig.xml` file, please
|
||||
see [MSDN](https://docs.microsoft.com/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85)).
|
||||
|
||||
## package.json
|
||||
|
||||
`package.json` is used to define attributes of your site or application for
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
* `start` builds your site and starts a server
|
||||
* `build` builds your `index.html` using Parcel
|
||||
* `dev` serves your `index.html` with a simple development server
|
||||
|
||||
* `keywords` - an array of keywords used to discover your app in the npm
|
||||
registry
|
||||
* `author` - defines the author (via `name`, `email` and `url` fields) of a
|
||||
package. There is also an alternative [contributors](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
|
||||
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
|
||||
simple web server.
|
||||
|
||||
6
dist/doc/usage.md
vendored
6
dist/doc/usage.md
vendored
@@ -38,7 +38,6 @@ A basic HTML5 Boilerplate site initially looks something like this:
|
||||
│ ├── main.js
|
||||
│ ├── plugins.js
|
||||
│ └── vendor
|
||||
│ ├── jquery.min.js
|
||||
│ └── modernizr.min.js
|
||||
├── .editorconfig
|
||||
├── .htaccess
|
||||
@@ -118,6 +117,11 @@ corresponding snippet at the bottom to include your analytics ID.
|
||||
Edit this file to include the team that worked on your site/app, and the
|
||||
technology powering it.
|
||||
|
||||
### package.jsom
|
||||
|
||||
Edit this file to describe your application, add dependencies, scripts and
|
||||
other properties related to node based development and the npm registry
|
||||
|
||||
### robots.txt
|
||||
|
||||
Edit this file to include any pages you need hidden from search engines.
|
||||
|
||||
6
dist/package.json
vendored
6
dist/package.json
vendored
@@ -13,7 +13,11 @@
|
||||
"template",
|
||||
"front-end"
|
||||
],
|
||||
"author": "",
|
||||
"author": {
|
||||
"name" : "",
|
||||
"email" : "",
|
||||
"url" : ""
|
||||
},
|
||||
"license": "",
|
||||
"devDependencies": {
|
||||
"parcel-bundler": "^1.12.4"
|
||||
|
||||
@@ -8,12 +8,6 @@ HTML5 Boilerplate's CSS includes:
|
||||
* [Normalize.css](#normalizecss)
|
||||
* [main.css](#maincss)
|
||||
|
||||
This starting CSS does not rely on the presence of [conditional class
|
||||
names](https://www.paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/),
|
||||
or [Modernizr](https://modernizr.com/), and it is ready to use no matter what
|
||||
your development preferences happen to be.
|
||||
|
||||
|
||||
## Normalize.css
|
||||
|
||||
In order to make browsers render all elements more consistently and in line with
|
||||
@@ -32,7 +26,6 @@ As opposed to CSS resets, Normalize.css:
|
||||
For more information about Normalize.css, please refer to its [project
|
||||
page](https://necolas.github.io/normalize.css/).
|
||||
|
||||
|
||||
## main.css
|
||||
|
||||
Several base styles are included that build upon `Normalize.css`. These styles:
|
||||
|
||||
@@ -7,7 +7,6 @@ Here is some useful advice for how you can make your project with HTML5
|
||||
Boilerplate even better. We don't want to include it all by default, as not
|
||||
everything fits with everyone's needs.
|
||||
|
||||
|
||||
* [App Stores](#app-stores)
|
||||
* [DNS prefetching](#dns-prefetching)
|
||||
* [Google Universal Analytics](#google-universal-analytics)
|
||||
@@ -100,7 +99,6 @@ Microsoft Ajax Content Delivery Network:
|
||||
* https://dev.chromium.org/developers/design-documents/dns-prefetching
|
||||
* https://docs.microsoft.com/en-us/archive/blogs/ie/internet-explorer-9-network-performance-improvements
|
||||
|
||||
|
||||
## Google Universal Analytics
|
||||
|
||||
### More tracking settings
|
||||
@@ -120,7 +118,6 @@ and
|
||||
[Event](https://developers.google.com/analytics/devguides/collection/analyticsjs/events)
|
||||
Docs.
|
||||
|
||||
|
||||
### Track jQuery AJAX requests in Google Analytics
|
||||
|
||||
An article by @JangoSteve explains how to [track jQuery AJAX requests in Google
|
||||
|
||||
@@ -9,6 +9,7 @@ table of contents](TOC.md)
|
||||
* [robots.txt](#robotstxt)
|
||||
* [humans.txt](#humanstxt)
|
||||
* [browserconfig.xml](#browserconfigxml)
|
||||
* [package.json](#packagejson)
|
||||
|
||||
--
|
||||
|
||||
@@ -166,3 +167,38 @@ Notice that IE11 uses the same images when adding a site to the `favorites`.
|
||||
|
||||
For more in-depth information about the `browserconfig.xml` file, please
|
||||
see [MSDN](https://docs.microsoft.com/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85)).
|
||||
|
||||
## package.json
|
||||
|
||||
`package.json` is used to define attributes of your site or application for
|
||||
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
|
||||
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
|
||||
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
|
||||
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
|
||||
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.
|
||||
|
||||
* `start` builds your site and starts a server
|
||||
* `build` builds your `index.html` using Parcel
|
||||
* `dev` serves your `index.html` with a simple development server
|
||||
|
||||
* `keywords` - an array of keywords used to discover your app in the npm
|
||||
registry
|
||||
* `author` - defines the author (via `name`, `email` and `url` fields) of a
|
||||
package. There is also an alternative [contributors](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
|
||||
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
|
||||
simple web server.
|
||||
|
||||
@@ -38,7 +38,6 @@ A basic HTML5 Boilerplate site initially looks something like this:
|
||||
│ ├── main.js
|
||||
│ ├── plugins.js
|
||||
│ └── vendor
|
||||
│ ├── jquery.min.js
|
||||
│ └── modernizr.min.js
|
||||
├── .editorconfig
|
||||
├── .htaccess
|
||||
@@ -118,6 +117,11 @@ corresponding snippet at the bottom to include your analytics ID.
|
||||
Edit this file to include the team that worked on your site/app, and the
|
||||
technology powering it.
|
||||
|
||||
### package.jsom
|
||||
|
||||
Edit this file to describe your application, add dependencies, scripts and
|
||||
other properties related to node based development and the npm registry
|
||||
|
||||
### robots.txt
|
||||
|
||||
Edit this file to include any pages you need hidden from search engines.
|
||||
|
||||
@@ -13,7 +13,11 @@
|
||||
"template",
|
||||
"front-end"
|
||||
],
|
||||
"author": "",
|
||||
"author": {
|
||||
"name" : "",
|
||||
"email" : "",
|
||||
"url" : ""
|
||||
},
|
||||
"license": "",
|
||||
"devDependencies": {
|
||||
"parcel-bundler": "^1.12.4"
|
||||
|
||||
Reference in New Issue
Block a user