| 1 |
--- |
| 2 |
layout: main |
| 3 |
title: Welcome to API documentation |
| 4 |
scripts: ["/site/assets/libs/jquery/jquery.min.js", "https://cdn.moot.it/latest/moot.min.js", "/site/assets/js/comments.min.js"] |
| 5 |
--- |
| 6 |
|
| 7 |
<h2>API documentation v2.0.0 (work in progress)</h2> |
| 8 |
<h4>This is evolving and will probably change as things advance</h4> |
| 9 |
<div class="intro"> |
| 10 |
Tidy up and accelerate your workflow |
| 11 |
</div> |
| 12 |
<ul> |
| 13 |
<li><a href="#setup">Setup</a></li> |
| 14 |
<li> |
| 15 |
<a href="#configuration">Configuration</a> |
| 16 |
<ul> |
| 17 |
<li>head_conf</li> |
| 18 |
<ul> |
| 19 |
<li>Screen breakpoints (lt, gt)</li> |
| 20 |
<li>Browser breakpoints (lt, gt)</li> |
| 21 |
<li>HTML5 Shim</li> |
| 22 |
<li>CSS Router: HashTag prefix</li> |
| 23 |
<li>CSS Router: Page prefix</li> |
| 24 |
<li>CSS Router: Section prefix</li> |
| 25 |
</ul> |
| 26 |
</ul> |
| 27 |
</li> |
| 28 |
<li> |
| 29 |
<a href="#responsive">Responsive Design</a> |
| 30 |
<ul> |
| 31 |
<li><a href="#browser">Browser Information</a></li> |
| 32 |
<ul> |
| 33 |
<li>head.browser.name</li> |
| 34 |
<li>head.browser.version</li> |
| 35 |
<li>head.browser.ie</li> |
| 36 |
<li>head.browser.ff</li> |
| 37 |
<li>head.browser.chrome</li> |
| 38 |
<li>head.browser.ios</li> |
| 39 |
<li>head.browser.android</li> |
| 40 |
<li>head.browser.webkit</li> |
| 41 |
<li>head.browser.opera</li> |
| 42 |
</ul> |
| 43 |
</ul> |
| 44 |
<ul> |
| 45 |
<li><a href="#screen">Screen Information</a></li> |
| 46 |
<ul> |
| 47 |
<li>head.screen.height</li> |
| 48 |
<li>head.screen.width</li> |
| 49 |
<li>head.screen.innerHeight</li> |
| 50 |
<li>head.screen.innerWidth</li> |
| 51 |
<li>head.screen.outerHeight</li> |
| 52 |
<li>head.screen.outerWidth</li> |
| 53 |
</ul> |
| 54 |
</ul> |
| 55 |
<ul> |
| 56 |
<li><a href="#features">Feature Detections</a></li> |
| 57 |
<ul> |
| 58 |
<li>head.feature(name, bool)</li> |
| 59 |
<ul><li>head.mobile</li></ul> |
| 60 |
<ul><li>head.desktop</li></ul> |
| 61 |
<ul><li>head.touch</li></ul> |
| 62 |
<ul><li>head.portrait</li></ul> |
| 63 |
<ul><li>head.landscape</li></ul> |
| 64 |
<ul><li>head.retina</li></ul> |
| 65 |
<ul><li>head.transitions</li></ul> |
| 66 |
<ul><li>head.transforms</li></ul> |
| 67 |
<ul><li>head.gradients</li></ul> |
| 68 |
<ul><li>head.opacity</li></ul> |
| 69 |
<ul><li>head.multiplebgs</li></ul> |
| 70 |
<ul><li>head.boxshadow</li></ul> |
| 71 |
<ul><li>head.borderimage</li></ul> |
| 72 |
<ul><li>head.borderradius</li></ul> |
| 73 |
<ul><li>head.cssreflections</li></ul> |
| 74 |
<ul><li>head.fontface</li></ul> |
| 75 |
<ul><li>head.rgba</li></ul> |
| 76 |
</ul> |
| 77 |
</ul> |
| 78 |
<ul> |
| 79 |
<li><a href="#html5">HTML5 Shim</a></li> |
| 80 |
</ul> |
| 81 |
<ul> |
| 82 |
<li><a href="#router">CSS Router</a></li> |
| 83 |
<ul> |
| 84 |
<li>page</li> |
| 85 |
<li>section</li> |
| 86 |
</ul> |
| 87 |
</ul> |
| 88 |
<ul> |
| 89 |
<li><a href="#ready">Document Ready</a></li> |
| 90 |
<ul><li>head.ready(document|label|filename|callback)</li></ul> |
| 91 |
</ul> |
| 92 |
</li> |
| 93 |
<li> |
| 94 |
<a href="#load">Resource Loading</a> |
| 95 |
<ul><li>head.load(js|css, callback)</li></ul> |
| 96 |
<ul><li>head.test(condition, success, failure, callback)</li></ul> |
| 97 |
</li> |
| 98 |
</ul> |
| 99 |
|
| 100 |
|
| 101 |
{% include api/2.0.0/setup.html %} |
| 102 |
{% include api/2.0.0/configuration.html %} |
| 103 |
|
| 104 |
<h1 id="responsive">Responsive Design</h1> |
| 105 |
<hr id="browser"/> |
| 106 |
{% include api/2.0.0/browser.html %} |
| 107 |
{% include api/2.0.0/screen.html %} |
| 108 |
{% include api/2.0.0/features.html %} |
| 109 |
{% include api/2.0.0/html5.html %} |
| 110 |
{% include api/2.0.0/router.html %} |
| 111 |
{% include api/2.0.0/ready.html %} |
| 112 |
{% include api/2.0.0/load.html %} |
| 113 |
|
| 114 |
<br /><br /> |
| 115 |
<div class="intro"> |
| 116 |
<strong>Make it the only script in your HEAD.</strong> |
| 117 |
« A concise solution to universal problems » |
| 118 |
</div> |
| 119 |
|
| 120 |
{% include sections/download.html %} |
| 121 |
|
| 122 |
<div id="moot"> </div> |
| 123 |
<div id="examples"> </div> |