diff --git a/README.md b/README.md index 47ede6e..eb8cf77 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -# HEAD +# \ + +[![CC0](https://img.shields.io/badge/license-CC0-green.svg)](https://creativecommons.org/publicdomain/zero/1.0/) +[![Contributors](https://img.shields.io/github/contributors/joshbuchea/head.svg)](https://github.com/joshbuchea/HEAD/graphs/contributors) +[![Amazon Referral](https://img.shields.io/badge/referral-amazon-yellow.svg)](https://amazon.com/?tag=buchea-20) A list of everything that could go in the `` of your document @@ -7,14 +11,12 @@ A list of everything that could go in the `` of your document - [Recommended Minimum](#recommended-minimum) - [Elements](#elements) - [Meta](#meta) - - [Meta: Not Recommended](#meta-not-recommended) - [Link](#link) - - [Link: Not Recommended](#link-not-recommended) - [Favicons](#favicons) - [Social](#social) - - [Facebook / Open Graph](#facebook--open-graph) - - [Facebook / Instant Articles](#facebook--instant-articles) - - [Twitter](#twitter) + - [Facebook Open Graph](#facebook-open-graph) + - [Facebook Instant Articles](#facebook-instant-articles) + - [Twitter Cards](#twitter-cards) - [Google+ / Schema.org](#google--schemaorg) - [OEmbed](#oembed) - [Browsers / Platforms](#browsers--platforms) @@ -23,7 +25,6 @@ A list of everything that could go in the `` of your document - [Google Android](#google-android) - [Google Chrome](#google-chrome) - [Microsoft Internet Explorer](#microsoft-internet-explorer) - - [Microsoft Internet Explorer: Legacy, Do Not Use!](#microsoft-internet-explorer-legacy-do-not-use) - [Browsers (Chinese)](#browsers-chinese) - [360 Browser](#360-browser) - [QQ Mobile Browser](#qq-mobile-browser) @@ -36,6 +37,7 @@ A list of everything that could go in the `` of your document - [Other Formats](#other-formats) - [Translations](#translations) - [Contributing](#contributing) +- [Contributors](#contributors) - [Author](#author) - [License](#license) @@ -46,7 +48,7 @@ Below are the essential tags for basic, minimalist websites: ```html - + Page Title ``` @@ -94,7 +96,7 @@ Below are the essential tags for basic, minimalist websites: - + @@ -106,20 +108,27 @@ Below are the essential tags for basic, minimalist websites: + + + + + + + + + + + + + + + - - - - - - - - @@ -150,67 +159,13 @@ Below are the essential tags for basic, minimalist websites: - [ICBM on Wikipedia](https://en.wikipedia.org/wiki/ICBM_address#Modern_use) - [Geotagging on Wikipedia](https://en.wikipedia.org/wiki/Geotagging#HTML_pages) -### Meta: Not Recommended -Below are the meta attributes which are not recommended for use as they had low adoption rate, or have been deprecated: - -```html - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -``` ## Link ``` html + + + @@ -220,9 +175,6 @@ Below are the meta attributes which are not recommended for use as they had low - - - @@ -230,7 +182,7 @@ Below are the meta attributes which are not recommended for use as they had low - + @@ -240,17 +192,11 @@ Below are the meta attributes which are not recommended for use as they had low - - + + - - - - - - - + @@ -258,7 +204,7 @@ Below are the meta attributes which are not recommended for use as they had low - + @@ -271,7 +217,7 @@ Below are the meta attributes which are not recommended for use as they had low - + @@ -289,29 +235,16 @@ Below are the meta attributes which are not recommended for use as they had low ``` -### Link: Not Recommended -Below are the link relations which are not recommended for use: - -```html - - - - -``` - ### Favicons ``` html - + - - - - - - + + + ``` - [All About Favicons (And Touch Icons)](https://bitsofco.de/all-about-favicons-and-touch-icons/) @@ -319,7 +252,7 @@ Below are the link relations which are not recommended for use: ## Social -### Facebook / Open Graph +### Facebook Open Graph ``` html @@ -331,14 +264,12 @@ Below are the link relations which are not recommended for use: - - ``` - [Facebook Open Graph Markup](https://developers.facebook.com/docs/sharing/webmasters#markup) - [Open Graph protocol](http://ogp.me/) -### Facebook / Instant Articles +### Facebook Instant Articles ``` html @@ -354,7 +285,7 @@ Below are the link relations which are not recommended for use: - [Facebook Instant Articles: Creating Articles](https://developers.facebook.com/docs/instant-articles/guides/articlecreate) - [Instant Articles: Format Reference](https://developers.facebook.com/docs/instant-articles/reference) -### Twitter +### Twitter Cards ``` html @@ -364,12 +295,10 @@ Below are the link relations which are not recommended for use: - - ``` - [Twitter Cards: Getting Started Guide](https://dev.twitter.com/cards/getting-started) -- [Twitter Card Validator](https://dev.twitter.com/docs/cards/validation/validator) +- [Twitter Card Validator](https://cards-dev.twitter.com/validator) ### Google+ / Schema.org @@ -418,20 +347,13 @@ Pinterest lets you prevent people from saving things from your website, accordin - - - - - - - - - - + + + - + @@ -444,7 +366,7 @@ Pinterest lets you prevent people from saving things from your website, accordin ```html - + ``` ### Google Android @@ -467,7 +389,7 @@ Pinterest lets you prevent people from saving things from your website, accordin - + ``` ### Google Chrome Mobile (Android Only) @@ -481,66 +403,36 @@ Since Chrome 31, you can set up your web app to "app mode" like Safari. - - - - - - + + ``` -[Google Developer](https://developer.chrome.com/multidevice/android/installtohomescreen) +- [Google Developer](https://developer.chrome.com/multidevice/android/installtohomescreen) ### Microsoft Internet Explorer ``` html - - + - - - + + + + + + + + + + - - - - - - - - - - - + - - - -``` - -### Microsoft Internet Explorer: Legacy, Do Not Use! - -``` html - - - - - - - - - - - - - - ``` ## App Links @@ -636,10 +528,19 @@ Example: - [Italian](https://github.com/Fakkio/HEAD) - [Japanese](http://coliss.com/articles/build-websites/operation/work/collection-of-html-head-elements.html) - [Russian/Русский](https://github.com/Konfuze/HEAD) +- [Turkish/Türkçe](https://github.com/mkg0/HEAD) ## Contributing -Open an issue or a pull request to suggest changes or additions. +**Open an issue or a pull request to suggest changes or additions.** + +### Guide + +The **HEAD** repository consists of two branches: + +#### 1. `master` + +This branch consists of the `README.md` file that is automatically reflected on the [\ Cheat Sheet](http://gethead.info/) website. All changes to the content of the cheat sheet as such should be directed to this file. Please follow these steps for pull requests: @@ -648,6 +549,12 @@ Please follow these steps for pull requests: - Don't include a trailing slash in self-closing elements — the HTML5 spec says they're optional - Consider including a link to documentation that supports your change +#### 2. `gh-pages` + +This branch is responsible for the [\ Cheat Sheet](http://gethead.info/) website. We use [Jekyll](https://jekyllrb.com/) to deploy the `README.md` Markdown file through [GitHub Pages](https://pages.github.com/). All website related modifications must be directed here. + +You might want to go through the [Jekyll Docs](https://jekyllrb.com/docs/home/) and understand how Jekyll works before working on this branch. + ### Contributors Check out all the super awesome [contributors](https://github.com/joshbuchea/HEAD/graphs/contributors). @@ -658,6 +565,6 @@ Check out all the super awesome [contributors](https://github.com/joshbuchea/HEA ## License -[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/) +[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/) To the extent possible under law, [Josh Buchea](http://joshbuchea.com) has waived all copyright and related or neighboring rights to this work.