This commit is contained in:
Suleiman Leadbitter 2016-04-27 13:42:07 +00:00
commit 2a5c759302
1 changed files with 168 additions and 179 deletions

347
README.md
View File

@ -1,110 +1,106 @@
# HEAD
A collection of HTML head elements.
A collection of HTML head elements for [Pug](https://www.npmjs.com/package/pug) (previously [Jade](http://jade-lang.com/)) files.
## Elements
``` html
<title>Page Title</title>
<base href="https://example.com/page.html">
<style>
``` jade
title Page Title
base(href='https://example.com/page.html')
style.
body { color: red; }
</style>
<script src="script.js"></script>
script(src='script.js')
```
## Meta Element
``` html
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<meta name="keywords" content="your,keywords,here,comma,separated,no,spaces">
<meta name="description" content="150 chars">
<meta name="subject" content="your website's subject">
<meta name="language" content="en">
<meta name="robots" content="index,follow">
<meta name="googlebot" content="index,follow">
<meta name="google" content="nositelinkssearchbox">
<meta name="google-site-verification" content="verification_token">
<meta name="revised" content="Sunday, July 18th, 2010, 5:15 pm">
<meta name="abstract" content="">
<meta name="topic" content="">
<meta name="summary" content="">
<meta name="classification" content="business">
<meta name="author" content="name, email@example.com">
<meta name="designer" content="">
<meta name="reply-to" content="email@example.com">
<meta name="owner" content="">
<meta name="url" content="https://example.com/">
<meta name="identifier-URL" content="https://example.com/">
<meta name="directory" content="submission">
<meta name="category" content="">
<meta name="coverage" content="Worldwide">
<meta name="distribution" content="Global">
<meta name="rating" content="General">
<meta name="referrer" content="never">
<meta name="revisit-after" content="7 days">
<meta http-equiv="refresh" content="300;url=https://example.com/">
<!-- Cache Control -->
<meta http-equiv="Expires" content="0">
<meta http-equiv="Pragma" content="no-cache">
<meta http-equiv="Cache-Control" content="no-cache">
``` jade
meta(charset='utf-8')
meta(http-equiv='x-ua-compatible', content='ie=edge')
meta(name='viewport', content='width=device-width, initial-scale=1')
// The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags
meta(name='keywords', content='your,keywords,here,comma,separated,no,spaces')
meta(name='description', content='150 chars')
meta(name='subject', content="your website's subject")
meta(name='language', content='en')
meta(name='robots', content='index,follow')
meta(name='googlebot', content='index,follow')
meta(name='google', content='nositelinkssearchbox')
meta(name='google-site-verification', content='verification_token')
meta(name='revised', content='Sunday, July 18th, 2010, 5:15 pm')
meta(name='abstract', content='')
meta(name='topic', content='')
meta(name='summary', content='')
meta(name='classification', content='business')
meta(name='author', content='name, email@example.com')
meta(name='designer', content='')
meta(name='reply-to', content='email@example.com')
meta(name='owner', content='')
meta(name='url', content='https://example.com/')
meta(name='identifier-URL', content='https://example.com/')
meta(name='directory', content='submission')
meta(name='category', content='')
meta(name='coverage', content='Worldwide')
meta(name='distribution', content='Global')
meta(name='rating', content='General')
meta(name='referrer', content='never')
meta(name='revisit-after', content='7 days')
meta(http-equiv='refresh', content='300;url=https://example.com/')
// Cache Control
meta(http-equiv='Expires', content='0')
meta(http-equiv='Pragma', content='no-cache')
meta(http-equiv='Cache-Control', content='no-cache')
```
## Link Element
``` html
<link rel="copyright" href="copyright.html">
<link rel="stylesheet" href="https://example.com/styles.css">
<link rel="alternate" href="https://feeds.feedburner.com/martini" type="application/rss+xml" title="RSS">
<link rel="alternate" href="https://example.com/feed.atom" type="application/atom+xml" title="Atom 0.3">
<link rel="alternate" href="https://es.example.com/" hreflang="es">
<link rel="me" href="https://google.com/profiles/thenextweb" type="text/html">
<link rel="archives" href="https://example.com/2003/05/" title="May 2003">
<link rel="index" href="https://example.com/" title="DeWitt Clinton">
<link rel="start" href="https://example.com/photos/pattern_recognition_1_about/" title="Pattern Recognition 1">
<link rel="prev" href="https://example.com/opensearch/opensearch-and-openid-a-sure-way-to-get-my-attention/" title="OpenSearch and OpenID? A sure way to get my attention.">
<link rel="search" href="/search.xml" type="application/opensearchdescription+xml" title="Viatropos">
<link rel="self" type="application/atom+xml" href="https://example.com/atomFeed.php?page=3">
<link rel="first" href="https://example.com/atomFeed.php">
<link rel="next" href="https://example.com/atomFeed.php?page=4">
<link rel="previous" href="https://example.com/atomFeed.php?page=2">
<link rel="last" href="https://example.com/atomFeed.php?page=147">
<link rel="shortlink" href="https://example.com/?p=43625">
<link rel="canonical" href="https://example.com/2010/06/9-things-to-do-before-entering-social-media.html">
<link rel="amphtml" href="https://www.example.com/url/to/amp-version.html">
<link rel="EditURI" href="https://example.com/xmlrpc.php?rsd" type="application/rsd+xml" title="RSD">
<link rel="pingback" href="https://example.com/xmlrpc.php">
<link rel="webmention" href="https://example.com/webmention">
<link rel="manifest" href="manifest.json">
<link rel="author" href="humans.txt">
<link rel="import" href="component.html">
<!-- Prefetching, preloading, prebrowsing -->
<link rel="dns-prefetch" href="//example.com/">
<link rel="preconnect" href="https://www.example.com/">
<link rel="prefetch" href="https://www.example.com/">
<link rel="prerender" href="https://example.com/">
<link rel="subresource" href="styles.css">
<link rel="preload" href="image.png">
<!-- More info: https://css-tricks.com/prefetching-preloading-prebrowsing/ -->
``` jade
link(rel='copyright', href='copyright.html')
link(rel='stylesheet', href='https://example.com/styles.css')
link(rel='alternate', href='https://feeds.feedburner.com/martini', type='application/rss+xml', title='RSS')
link(rel='alternate', href='https://example.com/feed.atom', type='application/atom+xml', title='Atom 0.3')
link(rel='alternate', href='https://es.example.com/', hreflang='es')
link(rel='me', href='https://google.com/profiles/thenextweb', type='text/html')
link(rel='archives', href='https://example.com/2003/05/', title='May 2003')
link(rel='index', href='https://example.com/', title='DeWitt Clinton')
link(rel='start', href='https://example.com/photos/pattern_recognition_1_about/', title='Pattern Recognition 1')
link(rel='prev', href='https://example.com/opensearch/opensearch-and-openid-a-sure-way-to-get-my-attention/', title='OpenSearch and OpenID? A sure way to get my attention.')
link(rel='search', href='/search.xml', type='application/opensearchdescription+xml', title='Viatropos')
link(rel='self', type='application/atom+xml', href='https://example.com/atomFeed.php?page=3')
link(rel='first', href='https://example.com/atomFeed.php')
link(rel='next', href='https://example.com/atomFeed.php?page=4')
link(rel='previous', href='https://example.com/atomFeed.php?page=2')
link(rel='last', href='https://example.com/atomFeed.php?page=147')
link(rel='shortlink', href='https://example.com/?p=43625')
link(rel='canonical', href='https://example.com/2010/06/9-things-to-do-before-entering-social-media.html')
link(rel='amphtml', href='https://www.example.com/url/to/amp-version.html')
link(rel='EditURI', href='https://example.com/xmlrpc.php?rsd', type='application/rsd+xml', title='RSD')
link(rel='pingback', href='https://example.com/xmlrpc.php')
link(rel='webmention', href='https://example.com/webmention')
link(rel='manifest', href='manifest.json')
link(rel='author', href='humans.txt')
link(rel='import', href='component.html')
// Prefetching, preloading, prebrowsing
link(rel='dns-prefetch', href='//example.com/')
link(rel='preconnect', href='https://www.example.com/')
link(rel='prefetch', href='https://www.example.com/')
link(rel='prerender', href='https://example.com/')
link(rel='subresource', href='styles.css')
link(rel='preload', href='image.png')
// More info: https://css-tricks.com/prefetching-preloading-prebrowsing/
```
### Favicons
``` html
<!-- For IE 10 and below -->
<!-- No link, just place a file called favicon.ico in the root directory -->
<!-- For IE 11, Chrome, Firefox, Safari, Opera -->
<link rel="icon" href="path/to/favicon-16.png" sizes="16x16" type="image/png">
<link rel="icon" href="path/to/favicon-32.png" sizes="32x32" type="image/png">
<link rel="icon" href="path/to/favicon-48.png" sizes="48x48" type="image/png">
<link rel="icon" href="path/to/favicon-62.png" sizes="62x62" type="image/png">
<!-- More info: https://bitsofco.de/all-about-favicons-and-touch-icons/ -->
``` jade
// For IE 10 and below
// No link, just place a file called favicon.ico in the root directory
// For IE 11, Chrome, Firefox, Safari, Opera
link(rel='icon', href='path/to/favicon-16.png', sizes='16x16', type='image/png')
link(rel='icon', href='path/to/favicon-32.png', sizes='32x32', type='image/png')
link(rel='icon', href='path/to/favicon-48.png', sizes='48x48', type='image/png')
link(rel='icon', href='path/to/favicon-62.png', sizes='62x62', type='image/png')
// More info: https://bitsofco.de/all-about-favicons-and-touch-icons/
```
- [All About Favicons (And Touch Icons)](https://bitsofco.de/all-about-favicons-and-touch-icons/)
@ -113,18 +109,18 @@ A collection of HTML head elements.
### Facebook / Open Graph
``` html
<meta property="fb:app_id" content="123456789">
<meta property="og:url" content="https://example.com/page.html">
<meta property="og:type" content="website">
<meta property="og:title" content="Content Title">
<meta property="og:image" content="https://example.com/image.jpg">
<meta property="og:description" content="Description Here">
<meta property="og:site_name" content="Site Name">
<meta property="og:locale" content="en_US">
<meta property="article:author" content="">
<!-- Facebook: https://developers.facebook.com/docs/sharing/webmasters#markup -->
<!-- Open Graph: http://ogp.me/ -->
``` jade
meta(property='fb:app_id', content='123456789')
meta(property='og:url', content='https://example.com/page.html')
meta(property='og:type', content='website')
meta(property='og:title', content='Content Title')
meta(property='og:image', content='https://example.com/image.jpg')
meta(property='og:description', content='Description Here')
meta(property='og:site_name', content='Site Name')
meta(property='og:locale', content='en_US')
meta(property='article:author', content='')
// Facebook: https://developers.facebook.com/docs/sharing/webmasters#markup
// Open Graph: http://ogp.me/
```
- [Facebook Open Graph Markup](https://developers.facebook.com/docs/sharing/webmasters#markup)
@ -132,16 +128,16 @@ A collection of HTML head elements.
### Twitter
``` html
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@site_account">
<meta name="twitter:creator" content="@individual_account">
<meta name="twitter:url" content="https://example.com/page.html">
<meta name="twitter:title" content="Content Title">
<meta name="twitter:description" content="Content description less than 200 characters">
<meta name="twitter:image" content="https://example.com/image.jpg">
<!-- More info: https://dev.twitter.com/cards/getting-started -->
<!-- Validate: https://dev.twitter.com/docs/cards/validation/validator -->
``` jade
meta(name='twitter:card', content='summary')
meta(name='twitter:site', content='@site_account')
meta(name='twitter:creator', content='@individual_account')
meta(name='twitter:url', content='https://example.com/page.html')
meta(name='twitter:title', content='Content Title')
meta(name='twitter:description', content='Content description less than 200 characters')
meta(name='twitter:image', content='https://example.com/image.jpg')
// More info: https://dev.twitter.com/cards/getting-started
// Validate: https://dev.twitter.com/docs/cards/validation/validator
```
- [Twitter Cards: Getting Started Guide](https://dev.twitter.com/cards/getting-started)
@ -149,10 +145,10 @@ A collection of HTML head elements.
### Google+ / Schema.org
``` html
<meta itemprop="name" content="Content Title">
<meta itemprop="description" content="Content description less than 200 characters">
<meta itemprop="image" content="https://example.com/image.jpg">
``` jade
meta(itemprop='name', content='Content Title')
meta(itemprop='description', content='Content description less than 200 characters')
meta(itemprop='image', content='https://example.com/image.jpg')
```
## Browser/Platform
@ -160,96 +156,89 @@ A collection of HTML head elements.
### Apple iOS
``` html
<!-- Smart App Banner -->
<meta name="apple-itunes-app" content="app-id=APP_ID,affiliate-data=AFFILIATE_ID,app-argument=SOME_TEXT">
<!-- Disable automatic detection and formatting of possible phone numbers -->
<meta name="format-detection" content="telephone=no">
<!-- Add to Home Screen -->
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="apple-mobile-web-app-title" content="App Title">
<!-- Touch Icons -->
<link rel="apple-touch-icon" href="apple-touch-icon.png">
<link rel="apple-touch-icon-precomposed" href="apple-touch-icon-precomposed.png">
<!-- In most cases, one 180×180px touch icon in the head is enough -->
<!-- If you use art-direction and/or want to have different content for each device, you can add more touch icons -->
<!-- Startup Image -->
<link rel="apple-touch-startup-image" href="startup.png">
<!-- More info: https://developer.apple.com/safari/library/documentation/appleapplications/reference/safarihtmlref/articles/metatags.html -->
``` jade
// Smart App Banner
meta(name='apple-itunes-app', content='app-id=APP_ID,affiliate-data=AFFILIATE_ID,app-argument=SOME_TEXT')
// Disable automatic detection and formatting of possible phone numbers
meta(name='format-detection', content='telephone=no')
// Add to Home Screen
meta(name='apple-mobile-web-app-capable', content='yes')
meta(name='apple-mobile-web-app-status-bar-style', content='black')
meta(name='apple-mobile-web-app-title', content='App Title')
// Touch Icons
link(rel='apple-touch-icon', href='apple-touch-icon.png')
link(rel='apple-touch-icon-precomposed', href='apple-touch-icon-precomposed.png')
// In most cases, one 180×180px touch icon in the head is enough
// If you use art-direction and/or want to have different content for each device, you can add more touch icons
// Startup Image
link(rel='apple-touch-startup-image', href='startup.png')
// More info: https://developer.apple.com/safari/library/documentation/appleapplications/reference/safarihtmlref/articles/metatags.html
```
- [Apple Meta Tags](https://developer.apple.com/library/safari/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html)
### Apple Safari
```html
<!-- Pinned Site -->
<link rel="mask-icon" href="icon.svg" color="red">
```jade
// Pinned Site
link(rel='mask-icon', href='icon.svg', color='red')
```
### Google Android
``` html
<meta name="theme-color" content="#E64545">
<!-- Add to homescreen -->
<meta name="mobile-web-app-capable" content="yes">
<!-- More info: https://developer.chrome.com/multidevice/android/installtohomescreen -->
``` jade
meta(name='theme-color', content='#E64545')
// Add to homescreen
meta(name='mobile-web-app-capable', content='yes')
// More info: https://developer.chrome.com/multidevice/android/installtohomescreen
```
### Google Chrome
``` html
<link rel="chrome-webstore-item" href="https://chrome.google.com/webstore/detail/APP_ID">
<!-- Disable translation prompt -->
<meta name="google" value="notranslate">
``` jade
link(rel='chrome-webstore-item', href='https://chrome.google.com/webstore/detail/APP_ID')
// Disable translation prompt
meta(name='google', value='notranslate')
```
### Microsoft Internet Explorer
``` html
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta http-equiv="cleartype" content="on">
<meta name="skype_toolbar" content="skype_toolbar_parser_compatible">
<!-- Pinned Site -->
<!-- IE 10 / Windows 8 -->
<meta name="msapplication-TileImage" content="pinned-tile-144.png">
<meta name="msapplication-TileColor" content="#009900">
<!-- IE 11 / Windows 9.1 -->
<meta name="msapplication-config" content="ieconfig.xml">
``` jade
meta(http-equiv='x-ua-compatible', content='ie=edge')
meta(http-equiv='cleartype', content='on')
meta(name='skype_toolbar', content='skype_toolbar_parser_compatible')
// Pinned Site
// IE 10 / Windows 8
meta(name='msapplication-TileImage', content='pinned-tile-144.png')
meta(name='msapplication-TileColor', content='#009900')
// IE 11 / Windows 9.1
meta(name='msapplication-config', content='ieconfig.xml')
```
### Microsoft Internet Explorer (LEGACY DO NOT USE)
``` html
<!-- Legacy Tags (DO NOT USE) -->
<meta name="mssmarttagspreventparsing" content="true">
<meta http-equiv="page-enter" content="revealtrans(duration=2,transition=2)">
<meta http-equiv="page-exit" content="revealtrans(duration=3,transition=12)">
``` jade
// Legacy Tags (DO NOT USE)
meta(name='mssmarttagspreventparsing', content='true')
meta(http-equiv='page-enter', content='revealtrans(duration=2,transition=2)')
meta(http-equiv='page-exit', content='revealtrans(duration=3,transition=12)')
```
## App Links
``` html
<!-- iOS -->
<meta property="al:ios:url" content="applinks://docs">
<meta property="al:ios:app_store_id" content="12345">
<meta property="al:ios:app_name" content="App Links">
<!-- Android -->
<meta property="al:android:url" content="applinks://docs">
<meta property="al:android:app_name" content="App Links">
<meta property="al:android:package" content="org.applinks">
<!-- Web Fallback -->
<meta property="al:web:url" content="http://applinks.org/documentation">
<!-- More info: http://applinks.org/documentation/ -->
``` jade
// iOS
meta(property='al:ios:url', content='applinks://docs')
meta(property='al:ios:app_store_id', content='12345')
meta(property='al:ios:app_name', content='App Links')
// Android
meta(property='al:android:url', content='applinks://docs')
meta(property='al:android:app_name', content='App Links')
meta(property='al:android:package', content='org.applinks')
// Web Fallback
meta(property='al:web:url', content='http://applinks.org/documentation')
// More info: http://applinks.org/documentation/
```
- [App Links Docs](http://applinks.org/documentation/)