Bones/docs/index.html

76 lines
26 KiB
HTML
Raw Normal View History

<!DOCTYPE html><html><head><title>Ribs
2013-10-17 06:13:56 -04:00
</title><meta charset="utf-8"><style>*{-moz-box-sizing:border-box;box-sizing:border-box;margin:0;padding:0;border:0}body{padding:60px 0 40px;background-color:hsl(207,10%,90%);color:hsl(207,5%,30%)}.container{max-width:1300px;margin:0 auto;padding:0 20px}.section{position:relative;margin-bottom:20px}.docs{position:relative;z-index:2;width:68%;min-height:200px;background-color:hsl(207,0%,100%);background-clip:padding-box;border:1px solid hsla(207,5%,5%,.1);border-radius:5px;box-shadow:0 0 3px hsla(207,5%,5%,.1)}.code{position:absolute;top:5px;bottom:5px;right:0;z-index:1;width:33%;padding:10px 10px 10px 20px;border-radius:0 5px 5px 0;border:1px solid hsla(207,20%,10%,.1);background-color:hsla(207,20%,95%,.9);background-clip:padding-box;opacity:.5;-webkit-transition:opacity .4s;-moz-transition:opacity .4s;-o-transition:opacity .4s;transition:opacity .4s}.code:hover{opacity:1}.preview{background:hsl(207,0%,100%);border-top:1px solid hsl(207,30%,95%);position:relative;z-index:1}.preview-code+.preview{margin-top:0;border-top:0}.preview iframe{display:block;width:100%;height:100%;overflow:hidden}.preview-code{position:relative;z-index:2;display:block;width:100%;color:hsl(207,9%,37%);max-height:200px;padding:10px 20px;overflow-y:auto;background:hsl(207,30%,95%);border:1px solid hsl(207,30%,85%);border-left:0;border-right;box-shadow:inset 0 1px 2px hsla(207,30%,10%,.1);line-height:1.1!important;resize:none}.preview-code:focus{outline:0;background:hsl(207,30%,97%);box-shadow:inset 0 1px 2px hsla(207,30%,10%,.1),0 0 5px hsla(207,75%,75%,.9)}.preview-code:last-child{border-bottom:0;border-radius:0 0 5px 5px}.resizeable{padding:15px;overflow:auto;background:hsl(207,0%,100%);box-shadow:0 0 2px hsla(207,10%,20%,.2);resize:both}.preview-code,pre{white-space:pre-wrap;word-wrap:break-word;overflow-y:auto}.code pre{height:100%;margin-top:0}.bar{position:fixed;left:0;right:0;z-index:1010;min-height:40px;line-height:40px;background-image:-webkit-linear-gradient(hsla(207,10%,35%,.97),hsla(207,5%,25%,.92));background-image:-moz-linear-gradient(hsla(207,10%,35%,.97),hsla(207,5%,25%,.92));background-image:-o-linear-gradient(hsla(207,10%,35%,.97),hsla(207,5%,25%,.92));background-image:linear-gradient(hsla(207,10%,35%,.97),hsla(207,5%,25%,.92))}.bar.top{top:0;box-shadow:0 1px 2px hsla(207,5%,0%,.2)}.bar.bottom{bottom:0;box-shadow:0 -1px 2px hsla(207,5%,0%,.2)}.bar ul{margin:0!important}.bar li{display:block;list-style:none}.bar .icon path{fill:hsla(27,10%,75%,.75)}.docs .icon path{fill:hsla(207,10%,75%,.5)}.docs .permalink:hover .icon path{fill:hsl(207,10%,75%)}.bar button{color:hsla(27,10%,75%,.75)}.bar button:hover .icon path,.bar button.is-active .icon path{fill:hsl(27,10%,85%)}.bar button:hover,.bar button.is-active{color:hsl(27,10%,85%)}.bar .icon{vertical-align:middle;display:inline-block}.bar,.bar a,.bar a:visited{color:hsl(27,10%,85%);text-shadow:1px 1px 0 hsla(27,5%,0%,.5)}.bar a:hover,.bar a.is-active{color:hsl(27,10%,95%);text-shadow:1px 1px 0 hsla(27,5%,0%,1);text-decoration:none}.brand{float:left;margin-right:20px;font-weight:700;font-size:16px;text-decoration:none}.brand,a.brand,a.brand:visited{color:hsl(27,5%,5%);text-shadow:1px 1px 0 hsla(27,5%,100%,.2)}.brand:hover,a.brand:hover{color:hsl(27,5%,0%);text-shadow:1px 1px 0 hsla(27,5%,100%,.3);text-decoration:none}.menu{font-size:12px}.menu>li{float:left;position:relative}.menu a{display:block;margin-right:15px}.dropdown-toggle{position:relative;padding-right:15px}.dropdown-toggle:after{display:block;position:absolute;right:0;top:18px;content:'';border:4px solid;border-left-color:transparent;border-right-color:transparent;border-bottom-color:transparent}.nav-results,.dropdown{position:absolute;z-index:1020;top:32px;left:-16px;width:175px;max-height:500px;padding:10px 0;overflow-y:auto;word-wrap:break-word;font-size:11px;line-height:20px;background-color:hsla(207,10%,25%,.97);border:1px solid hsla(207,5%,70%,.3);border-radius:3px;box-shadow:0 0 3px hsla(207,5%,0%,.2)}.toc-list{width:200px}.nav-results{right:0;width:200px;left:auto;padding:5px 0}.nav-results-filename{display:block;font
<blockquote>
<p>Ribs is the evolution of Skeleton, the original author seems to have disappeared and/or lost interest in the project, and my colleagues and I use this an awful lot.</p>
</blockquote>
<h2 id="whats-different-here">What&#39;s different here?</h2>
<p>My fork has one significant difference over the original project, that is a full SCSS conversion to make use of more modern technologies and to expose a lot more customisation options quickly and easily.</p>
<p>As time goes by, and with enough interest I will gradually extend the available options and build a packaging tool that allows you to select all of your customisations in a graphical way - thinking something along the lines of jQuery themeroller, just a bit more lightweight.</p>
<h3 id="some-key-differences">Some Key Differences</h3>
<ul>
<li>Maintained!</li>
<li>Configurable grid</li>
<li>Default colours, borders, fonts, margins, padding etc are all configurable variables</li>
<li>Normalized elements, rather than the old school CSS resets</li>
<li>Sensible Table styles</li>
<li>Taking advantage of sass, the majority of selector repetition is removed in favour of mixins that generate the selectors</li>
<li>Many issues flagged by CSSLint refactored to resolve them</li>
<li>The original CSS has been split out into individual files and heavily refactored to tidy it up</li>
<li>Golden ratio default line heights</li>
<li>A selection of useful mixins</li>
<li>Push and pull column classes</li>
<li>Bower installable</li>
</ul>
<h2 id="installing">Installing</h2>
<p>Either clone this repository and drop in manually, or install from bower:</p>
<textarea class="preview-code" spellcheck="false">bower install --save ribs</textarea><h2 id="build-status">Build status</h2>
<p>The project is set up to build and run csslint on Travis:</p>
<ul>
<li>Master: <a href="https://travis-ci.org/nickpack/Ribs"><img src="https://travis-ci.org/nickpack/Ribs.png" alt="Build Status"></a></li>
<li>Development: <a href="https://travis-ci.org/nickpack/Ribs"><img src="https://travis-ci.org/nickpack/Ribs.png?branch=develop" alt="Build Status"></a></li>
</ul>
<h2 id="building">Building</h2>
<p>I&#39;ve added grunt configuration to the repository for those of you that use it.</p>
<p>There are 4 main tasks added:
<em> default - Runs Sass to create the stylesheet from the source files, places the output in ./css then creates a minified version of the file and places it into the same directory
</em> test - This runs CSSLint over the output CSS file (Note that there are a few bits in the original skeleton css that I still need to fix!)
<em> minify - This literally just runs cssmin, useful if you&#39;ve edited Ribs.css directly
</em> watch - This will monitor the scss directory for changes and automatically rebuild the css and minified css (Effectively the same as sass --watch but with added minification)</p>
<h3 id="to-get-started-with-the-grunt-tools">To get started with the grunt tools</h3>
<p>You need to install grunt-cli globally (<code>npm install -g grunt-cli</code>) to start with, otherwise you wont have a runner!
Then following that, from the root dir of this project, run <code>npm install</code> which will set up all of the required dependencies.</p>
<p>You should be good to go.</p>
<h2 id="changelog">Changelog</h2>
<ul>
2013-10-17 06:13:56 -04:00
<li>Oct 17, 2013 - (v1.0.11) Renamed component.json to bower.json due to deprecation</li>
<li>Oct 15, 2013 - (v1.0.10) Resolved some issues with the grid system (Switched to margins for push/pull and removed tablet specific alpha and omega classes), Added a couple of example files.</li>
2013-10-15 14:19:50 -04:00
<li>Oct 15, 2013 - (v1.0.9) Default flag added to variables - Thanks to Ivo Bathke (@ivoba)</li>
2013-10-10 13:38:54 -04:00
<li>Oct 10, 2013 - (v1.0.8) Initial inline documentation, styledocco based docs generation, fixed breakpoint oversight on media queries for tablet and mobile</li>
<li>Oct 10, 2013 - (v1.0.7) Documented the differences between the original skeleton project and Ribs, Updated normalize to 2.1.3</li>
<li>Aug 7, 2013 - (v1.0.6) Some additional variables, grid push and pull</li>
<li>Jul 17, 2013 - (v1.0.5) Some additional variables, some base table styling</li>
<li>Jul 14, 2013 - (v1.0.4) Removed reset and replaced it with normalize</li>
<li>May 30, 2013 - (v1.0.3) Added 1.5 * font size line heights to headings and paragraphs</li>
<li>May 28, 2013 - Rename project to Ribs</li>
<li>May 17, 2013 - (v1.0.2) Travis CI build configuration, and minor refactor to remove as many of the warnings from CSSLint as was feasible to do - MAY CAUSE REGRESSIONS.</li>
<li>May 17, 2013 - (v1.0.1) Added grunt build tools</li>
<li>Apr 23, 2013 - (v1.0.0) Skeleton SCSS v1.0 - Additional variable conversions, changes based on feedback to the original project and bower submission.</li>
<li>Jan 31, 2013 - Completed SCSS conversion of Skeleton 1.2.</li>
</ul>
<h2 id="contributers">Contributers</h2>
<ul>
<li>Nick Pack</li>
2013-10-15 14:19:50 -04:00
<li>Ivo Bathke</li>
<li>Matthew Copeland</li>
<li>Miles Z. Sterrett</li>
<li>AtomicPages LLC</li>
<li>Toby Vervaart</li>
<li>Dave Gamache</li>
</ul>
<h2 id="licence">Licence</h2>
<p>Copyright (c) 2013 Nick Pack
Based on the original skeleton project which is Copyright 2011 Dave Gamache
Licensed under the MIT license.</p>
<p><a href="https://bitdeli.com/free" title="Bitdeli Badge"><img src="https://d2weczhvl823v0.cloudfront.net/nickpack/Ribs/trend.png" alt="Bitdeli Badge"></a></p>
</div></article></section><div class="bar bottom"><div hidden class="settings container"><!-- Icons from http://iconmonstr.com--><button title="Desktop (1280)" data-width='1280'><svg viewBox="0 0 412 386" height="24" width="26" class="icon"><path d="m147.6,343.9c-4.5,15.9-26.2,37.6-42.1,42.1h201c-15.3,-4-38.1,-26.8-42.1,-42.1H147.6zM387,0.5H25c-13.8,0-25,11.2-25,25V294c0,13.8 11.2,25 25,25h362c13.8,0 25,-11.2 25,-25V25.5C412,11.7 400.8,0.5 387,0.5zM369.9,238.2H42.1L42.1,42.6 369.9,42.6V238.2z"></path></svg></button><button title="Laptop (1024)" data-width='1024'><svg viewBox="0 0 384 312" height="23" width="28" class="icon"><path d="m349.2,20.5c0,-11-9,-20-20,-20H53.6c-11,0-20,9-20,20v194H349.2v-194zm-27,167H60.6V27.5H322.2v160zm28,42H32.6L2.6,282.1c-3.5,6.2-3.5,13.8 0.1,19.9 3.6,6.2 10.2,9.9 17.3,9.9H363.1c7.1,0 13.7,-3.8 17.3,-10 3.6,-6.2 3.6,-13.8 0,-20l-30.2,-52.5zm-196.9,54 8,-23.5h60.5l8,23.5h-76.5z"></path></svg></button><button title="Tablet (768)" data-width='768'><svg viewBox="0 0 317 412" height="24" width="18" class="icon"><path d="M 316.5,380 V 32 c 0,-17.7 -14.3,-32 -32,-32 H 32 C 14.3,0 0,14.3 0,32 v 348 c 0,17.7 14.3,32 32,32 h 252.5 c 17.7,0 32,-14.3 32,-32 z M 40,367 V 45 H 276.5 V 367 H 40 z m 109.8,22.7 c 0,-4.7 3.8,-8.5 8.5,-8.5 4.7,0 8.5,3.8 8.5,8.5 0,4.7 -3.8,8.5 -8.5,8.5 -4.7,0 -8.5,-3.8 -8.5,-8.5 z"></path></svg></button><button title="Smart phone (320)" data-width='320'><svg viewBox="0 0 224 412" height="24" width="13" class="icon"><path d="M 190.7,0 H 33 C 14.8,0 0,14.8 0,33 v 346 c 0,18.2 14.8,33 33,33 h 157.7 c 18.2,0 33,-14.8 33,-33 V 33 c 0,-18.2 -14.8,-33 -33,-33 z M 94.3,30.2 h 37 c 2.2,0 4,1.8 4,4 0,2.2 -1.8,4 -4,4 h -37 c -2.2,0 -4,-1.8 -4,-4 0,-2.2 1.8,-4 4,-4 z m 18.5,362.8 c -8.8,0 -16,-7.2 -16,-16 0,-8.8 7.2,-16 16,-16 8.8,0 16,7.2 16,16 0,8.8 -7.2,16 -16,16 z M 198.6,343.8 H 25.1 V 68.2 h 173.5 v 275.5 z"></path></svg></button><button title="Feature phone (240)" data-width='240'><svg viewBox="0 0 201 412" height="24" width="12" class="icon"><path d="M 165.5,0.2 V 45 H 25 c -13.8,0 -25,11.2 -25,25 V 387 c 0,13.8 11.2,25 25,25 h 150.5 c 13.8,0 25,-11.2 25,-25 V 0.2 h -35 z M 65.2,366.5 H 34.2 v -24.5 h 31 v 24.5 z m 0,-44.3 H 34.2 v -24.5 h 31 v 24.5 z m 50.5,44.3 H 84.7 v -24.5 h 31 v 24.5 z m 0,-44.3 H 84.7 v -24.5 h 31 v 24.5 z m 50.5,44.3 h -31 v -24.5 h 31 v 24.5 z m 0,-44.3 h -31 v -24.5 h 31 v 24.5 z m 0,-59.3 h -132 V 95.4 h 132 V 262.9 z"></path></svg></button><button title="Auto (100%)" data-width="auto" class="auto is-active">Auto</button></div></div><script>(function(){var a=[{title:"Ribs",filename:"Ribs",url:"Ribs.html"},{title:"Ribs",filename:"Ribs",url:"Ribs.html#ribs"},{title:"Import of normalize, variables and mixins",filename:"Ribs",url:"Ribs.html#import-of-normalize-variables-and-mixins"},{title:"General body style",filename:"Ribs",url:"Ribs.html#general-body-style"},{title:"General horizontal rule style",filename:"Ribs",url:"Ribs.html#general-horizontal-rule-style"},{title:"Import of ribs functionality",filename:"Ribs",url:"Ribs.html#import-of-ribs-functionality"},{title:"Example Media Queries",filename:"Ribs",url:"Ribs.html#example-media-queries"},{title:"forms",filename:"forms",url:"forms.html"},{title:"Buttons",filename:"forms",url:"forms.html#buttons"},{title:"Forms",filename:"forms",url:"forms.html#forms"},{title:"grid",filename:"grid",url:"grid.html"},{title:"Grid System",filename:"grid",url:"grid.html#grid-system"},{title:"Desktop Grid",filename:"grid",url:"grid.html#desktop-grid"},{title:"Tablet Grid",filename:"grid",url:"grid.html#tablet-grid"},{title:"Mobile Grid",filename:"grid",url:"grid.html#mobile-grid"},{title:"Clearing",filename:"grid",url:"grid.html#clearing"},{title:"images",filename:"images",url:"images.html"},{title:"Images",filename:"images",url:"images.html#images"},{title:"links",filename:"links",url:"links.html"},{title:"Links",filename:"links",url:"links.html#links"},{title:"lists",filename:"lists",url:"lists.html"},{title:"Lists",filename:"lists",url:"lists.html#lists"},{title:"mixins",filename:"mixins",url:"mixins.html"},{title:"",filen