Commit Graph

73 Commits

Author SHA1 Message Date
Rob Larsen
e87f11bff8 Moving docs out of src and dist (#2655)
* Moving docs out of src and dist

* Changing links to doc
2021-12-02 16:08:26 -05:00
Cătălin Mariș
9318c6321a Change project architecture
* Move all the H5BP source files into the `src/` directory and remove
  all external components that can be fetch via `npm`, namely: the
  Apache Server Configs, jQuery, and Normalize.css.

* Add `package.json`, and move to using `npm` for managing dependencies
  (for more information about `npm`, see: https://www.npmjs.org/doc/).

* Add `gulp` based build script to allows us to automatically create
  the distribution files as well as an archive that can then be attached
  to the release - https://github.com/blog/1547-release-your-software
  (for more information about gulp, see: http://gulpjs.com/).

* Add other miscellaneous files to help us in our development process:

   * `.editorconfig` - to define and maintain consistent coding styles
                       http://editorconfig.org/

   * `.jshintrc`     - to specify JSHint configuration options
                       http://www.jshint.com/docs/

   * `.travis.yml`   - to specify Travis CI configuration options
                       http://docs.travis-ci.com/

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

These changes:

  * automate some of the tedious work (e.g.: updating the external
    components, updating some of the inline content such as version
    numbers, etc.)

  * will allow us to experiment more (e.g.: allow us to create different
    builds of H5BP, builds that can contain different components)

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref h5bp/html5-boilerplate#1563
Close h5bp/html5-boilerplate#1563
2014-08-04 19:02:30 +03:00
Arthur Verschaeve
8ef199adf6 Docs: Add information about PHP's built-in server
Ref: http://php.net/manual/en/features.commandline.webserver.php
Close: h5bp/html5-boilerplate#1569.
2014-07-29 14:34:37 +03:00
₍˄ุ.͡˳̫.˄ุ₎
c3d967ab25 Docs: Remove gendered pronoun from faq.md
Close: h5bp/html5-boilerplate#1566.
2014-07-27 12:41:58 +03:00
Cătălin Mariș
3c3c5e6460 Docs: Remove minimal-ui related information
The `minimal-ui` viewport property was introduced in iOS 7.1,
but it will no longer be supported in iOS 8.

Ref: https://developer.apple.com/library/prerelease/ios/releasenotes/General/RN-iOSSDK-8.0/#//apple_ref/doc/uid/TP40014223-CH1-SW83
Close: h5bp/html5-boilerplate#1565
2014-07-23 01:55:04 +03:00
Jonathan Neal
a99d8563dd Add /.editorconfig file
The addition of the `/.editorconfig` file is made in order to
encourage and help developers and their teams define and maintain
consistent coding styles between their different editors and IDEs.

By default, `/.editorconfig` includes some basic properties that
reflect the coding styles from the files provided by default, but
users can easily change them to better suit their needs.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Since users need to install a editor/IDE plugin in order for the
properties from the `/.editorconfig` to be applied, we were reluctant
to add this file in the past (see: h5bp/html5-boilerplate#1124).
Nowadays however, the EditorConfig project provides plugins for most
of the popular editors/IDEs (see: http://editorconfig.org/#download),
plus, more and more developers are using it.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: http://editorconfig.org/

Close: h5bp/html5-boilerplate#1561
       h5bp/html5-boilerplate#1564
2014-07-21 23:08:02 +03:00
Cătălin Mariș
973b8453de Docs: Make minor improvments in html.md 2014-07-19 03:35:08 +03:00
Philip Walton
4fca586fae Add auto to the GA tracker create method
The Google Universal Analytics now supports automatic cookie domain
configuration simply by adding `auto` to the analytics tracker create
method: `ga('create', 'UA-XXXX-Y', 'auto');`.

From https://developers.google.com/analytics/devguides/collection/analyticsjs/domains#auto:

  "Automatic Cookie Domain Configuration simplifies cross domain
   tracking implementations by automatically writing cookies to the
   highest level domain possible when the auto parameter is used.
   When used on the domain www.example.co.uk, it will try to write
   cookies in the following order:

     1. co.uk
     2. example.co.uk
     3. www.example.co.uk

   Analytics.js will fail to write a cookie on co.uk but will succeed
   on example.co.uk. Since a cookie was succesfully written on a higher
   level domain, www.example.co.uk will be skipped"

So, when this parameter is omitted (as it was prior to this commit),
Google Universal Analytics will default to using `location.hostname`,
which will include the subdomain, preventing websites with multiple
subdomains from being able to automatically track unique users across
those subdomains.

Note: The `auto` parameter is now officially part of the recommended
Google Universal Analytics snippet.
https://developers.google.com/analytics/devguides/collection/analyticsjs/

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: https://developers.google.com/analytics/devguides/collection/analyticsjs/domains#auto
Close: h5bp/html5-boilerplate#1562.
2014-07-17 15:20:12 +03:00
Arthur Verschaeve
5027eeaab2 Docs: Update info from js.md regarding plugins.js
Add information about the script from the `plugins.js` file.

Ref   h5bp/html5-boilerplate#1554
Close h5bp/html5-boilerplate#1558
2014-07-11 18:00:34 +03:00
Arthur Verschaeve
ff27f8c563 Docs: Add basic info about .htaccess in misc.md
Ref   h5bp/html5-boilerplate#1554
Close h5bp/html5-boilerplate#1557
2014-07-10 13:15:57 +03:00
Cătălin Mariș
8935453014 Docs: Update jQuery CDN related info from faq.md
Update documentation to include the information from the recent
jQuery team announcement:

   "To mitigate the risk of “breaking the web”, the jQuery team
    decided back in 2013 that jquery-latest.js could not be
    upgraded to the 2.0 branch even though that is technically
    the latest version. There would just be too many sites that
    would mysteriously stop working with older versions of Internet
    Explorer, and many of those sites may not be maintained today.

    As jQuery adoption has continued to grow, even that safeguard
    seems insufficient to protect against careless use of
    http://code.jquery.com/jquery-latest.js. So we have decided to
    stop updating this file, as well as the minified copy, keeping
    both files at version 1.11.1 forever ...

    The Google CDN team has joined us in this effort to prevent
    inadvertent web breakage and no longer updates the file at
    http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.js. That
    file will stay locked at version 1.11.1 as well."

   (from: http://blog.jquery.com/2014/07/03/dont-use-jquery-latest-js/)

Ref: h5bp/html5-boilerplate#1554
2014-07-05 17:48:11 +03:00
Cătălin Mariș
0443e50892 Docs: Update and improve css.md 2014-07-01 00:18:55 +03:00
Cătălin Mariș
0efb9fb4df Docs: Update and improve TOC.md
* Make minor updates and improvements.
* Remove `.htaccess` mention as the Apache server configs are no longer
  part of the HTML5 Boilerplate core, plus, more information about them
  will be included in the `misc.md` file.
2014-06-28 00:52:55 +03:00
Cătălin Mariș
296b0bbf25 Docs: Update and improve faq.md 2014-06-25 00:08:04 +03:00
Cătălin Mariș
3220cf1d63 Docs: Move crossdomain.xml info into misc.md
Update and improve the `crossdomain.xml` related documentation,
as well as move it into the `misc.md` file.

The move is made in order to be more consistent (we don't have
special pages for any of the other "miscellaneous" files).
2014-06-24 23:52:35 +03:00
Cătălin Mariș
5e0b0d642b Update links 2014-06-21 03:18:30 +03:00
Ismay
a82c61fb3e Docs: Update content regarding Google Analytics
* Explain the reason for providing the Google Universal Analytics
  snippet by default.

* Make it more clear that users are encouraged to use whatever
  tracking solution suits their needs best.

Ref h5bp/html5-boilerplate#1547
Close h5bp/html5-boilerplate#1548
2014-06-13 01:17:30 +03:00
Alastair Hole
ee0de7541f Docs: Make minor grammar change in extend.md
Close h5bp/html5-boilerplate#1517.
2014-03-13 19:55:17 +02:00
Tom Fuertes
7997c1b9a1 Docs: Update content regarding Google Analytics
Close: h5bp/html5-boilerplate#1490
       h5bp/html5-boilerplate#1515
2014-03-02 09:41:57 +02:00
Rob Larsen
f639653d3d Docs: Improve content about use of CDN for jQuery
Ref: https://github.com/h5bp/html5-boilerplate/issues/1498#issuecomment-33163993.
Close: #1511, #1514.
2014-02-25 09:48:00 +02:00
XhmikosR
106bb43c37 Docs: Fix typo in extend.md
Close #1510.
2014-02-23 13:49:57 +02:00
Cătălin Mariș
4d7ba31ada Docs: Use Bootstrap instead of "Twitter Bootstrap"
"Twitter Bootstrap" is now simply known as "Bootstrap".

Ref: http://getbootstrap.com/about/#brand

Thanks @cvrebert.
2014-02-23 13:46:07 +02:00
Abhinay Rathore
cacfa08050 Docs: Add Separate mobile URLs subsection
Inform users that, if they use separate URLs for desktop and mobile
users, they should consider helping search engine algorithms better
understand the configuration on their web site.

See also:

 * https://developers.google.com/webmasters/smartphone-sites/details#separateurls
 * https://developers.google.com/webmasters/smartphone-sites/feature-phones

Close #1504.
2014-02-01 12:16:39 +02:00
Cătălin Mariș
76d3021d19 Docs: Update the Apple Touch Icons section
* Add note about `precomposed` not being required anymore, as starting
  with iOS 7, no special effects are applied to the touch icons.

* Add missing touch icon sizes.

Close #1488
2014-01-10 21:15:04 +02:00
Hans Christian Reinl
a557ea0513 Docs: Add note about Chrome Mobile web apps
"Add to Homescreen" feature in Chrome Mobile

Closes #1441.
2013-12-26 13:42:34 +01:00
Cătălin Mariș
57be193031 Remove default margin from print styles
Providing a default value (such as `5cm`) for the print margins is
problematic because:

 1) in some browsers, it prevents users from customizing the browser
    print settings
 2) in some contexts (browser/os/printer), the value may be too:
    * small, and the margins may collide with all the different
      headers/footers (URL, date, etc) that are usually printed
      by default
    * big, and the margins will just waste the space

Most browsers provide a default non-zero value for the print margins,
so it's better to not specify a value at all, and just let them handle
this themselves.

See also:

 * http://www.w3.org/TR/css3-page/#at-page-rule
 * https://developer.mozilla.org/en-US/docs/Web/CSS/@page

Close #1477.
2013-12-25 02:10:15 +02:00
Connor McSheffrey
f4a2cbfcad Docs: Add note about iOS 7.1 minimal-ui property
Ref: #1485.
Close: #1485.
2013-12-20 13:13:30 +02:00
Cătălin Mariș
df2306766e Docs: Make minor improvements in extend.md
* Wrap text at 80 characters.
* Rephrase content from the `Apple Touch Icons` section to limit subject
  to only `apple-touch-icon`s (ref: #1486).
* Other improvements.
2013-12-20 12:56:49 +02:00
Hans Christian Reinl
15b5cb1b5c Docs: Add comment about lang attribute on <html>
We don't set a default `lang` attribute on `<html>` due to the
discussion in #1110. This commit adds a note about how to set it.

Close #1483.
2013-12-20 12:05:33 +02:00
Anselm Hannemann
d592953e7a Clarify the default of only 2 icons
In extend.md, which is linked as source for 'more details' on the
touch-icons and favicon, this commit clarifies that by default two
icons are enough if one doesn't want to use art-direction.
2013-12-19 22:47:51 +01:00
Hans Christian Reinl
49e4569d02 Docs: Add anchor for MDN link to meta charset 2013-12-15 22:03:01 +01:00
David Walsh
24420747fd Docs: Update MDN link paths 2013-12-15 22:00:24 +01:00
Cătălin Mariș
fbffd2322d Docs: Update links and reorganize extend.md
* Update various links.
* Remove link to the `Node build script` repository as the project is no
  longer maintained.
* Better organize the information provided in `extend.md` by rearranging
  the sections alphabetically by title, and including a table of content
  for faster navigation.
2013-11-19 16:22:16 +02:00
Cătălin Mariș
ca1ced9654 Docs: Update server configs links
* Replace links to the Apache Server Configs `doc`
  directory, as it no longer exists:
  4f778c4a22.

* Provide missing links under the `X-UA-Compatible`
  section in the `html.md` file.
2013-11-19 10:56:54 +02:00
Hans Christian Reinl
f1a8e914be Remove image replacement helper class .ir
This class was removed because it doesn't provide enough use
cases within modern web development. Cases are mostly handled
indiviually by developers.

Reference #1472.
Closes #1475.
2013-11-18 23:39:22 +01:00
Jeffrey Godwyll
87274cb181 Fix typo in doc/css.md 2013-11-03 16:13:35 -08:00
Joseph Jaber
3f91469e7f Fix typo in header of doc/html.md (promt → prompt)
Close #1459.
2013-11-01 10:51:34 +02:00
Cătălin Mariș
dc752d7952 Docs: Remove outdated info on Skype highlighting
The snippet provided in the docs about how to prevent the Skype
plugin from formatting numbers on a web pages is outdated and no
longer works.

Nowadays, the Skype plugin makes it more difficult to overwrite
its injected styles (class names include timestamps, e.g.:
`skype_pnh_print_container_1381964168`, `!important` is used, etc.).

Providing a solution for this use case isn't viable. Also, users
that install such a plugin usually expect the behavior.

Close #1454.
2013-10-17 18:21:29 +03:00
Cătălin Mariș
6d10fc8cce Docs: Add info about how to block Google Translate
Inform users on how to disable the translation prompt in Chrome or
block Google Translate from translating a web page or any particular
section of the web page.

See also: https://support.google.com/translate/?hl=en#2641276.

Close: #1440.
2013-10-03 21:29:02 +03:00
Cătălin Mariș
18d3a9dd9e Update documentation and README.md
Remove content regarding legacy browsers.

Ref: #1050.
2013-09-29 12:01:42 +03:00
Cătălin Mariș
13f17a737a Remove IE conditional classes
The reasons behind this decision include the following:

* This project will drop legacy browser support (see #1050), therefore,
  the use for conditional classes for IE 8+, becomes much more limited.
* IE 10+ does not support conditional comments:
  http://msdn.microsoft.com/en-us/library/ms537512%28v=VS.85%29.aspx.
* Users do and can develop easily without using the conditional
  classes, this technique being very limited in scope as no other
  browser versions are explicitly target in the same way.
* It fixes the issue that prevents IE from honouring
  `<meta http-equiv="X-UA-Compatible" content="IE=edge">` (see: #1187).

This change also removes the related documentation.

Close #1290 and #1187.
2013-09-24 11:38:05 +03:00
Hans Christian Reinl
fdbff109c9 Remove notes about Google Chrome Frame from docs
Currently we don't use Google Chrome Frame anymore as support for
it will end at the end of the year.
This commit removes references to Chrome Frame within the
documentation. It is related to 2cf1ef7.

Reference #1433.
2013-09-20 16:18:55 +02:00
Hans Christian Reinl
71ca9fb7a0 Use one apple-touch-icon instead of six
This commit removes five Apple Touch Icons with different sizes for
the same icon and adds a new icon `apple-touch-icon-precomposed.png`
with a resolution of 152×152px.
Apart from that it adds documentation on how to add more icons if
you need them within your project.
Using only one Apple Touch Icon saves time and is enough in most
cases.

Closes #1367.
Closes #1425.
2013-09-04 14:09:47 +02:00
Roland Warmerdam
8a68443746 Docs: Update the Track JS errors in GA section
Add column number parameter to the example to reflect the recent changes
in the specification and in the Chrome and IE 10 implementations.

http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#errorevent
https://code.google.com/p/chromium/issues/detail?id=264197

Close #1417.
2013-08-15 13:31:35 +03:00
Hans Christian Reinl
2cf1ef7cea Docs: Update section about the X-UA-Compatible meta option
Chrome Frame is not supported anymore and we removed the option in
8fc2650.
This commit removes the documentation about Chrome Frame in the
X-UA-Compatible meta tag docs.

Related to #1396.
2013-08-14 14:30:49 +02:00
Cătălin Mariș
5bc2a985c7 Docs: Update .htaccess related info and links 2013-08-01 19:24:27 +03:00
Snugug
ff37dba6bf Add initial-scale=1 to meta viewport
iOS 6 fixes the infamous orientation change bug, so a better experience
is provided by reintroducing `initial-scale=1`.
2013-06-30 13:45:20 -07:00
alrra
8f743702f6 Docs: update information about print styles
Fix: h5bp/html5-boilerplate#1386
2013-06-14 12:03:52 +03:00
Hans Christian Reinl
52f17087f9 Add documentation for iOS web applications
Add several options to improve iOS web apps with meta tags when
adding a web page to the Home Screen.

Closes #1352.
2013-05-10 10:48:25 +02:00
alrra
7a22a33d40 Docs: fix broken links 2013-04-12 17:40:55 +03:00