add abbr styles, overhaul type docs section to remove lots of verbose text and put emphasis on tables and more scannable content
This commit is contained in:
Mark Otto
parent
d035fa731a
commit
27cbe7f63a
|
|
@ -6,7 +6,7 @@
|
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Designed and built with all the love in the world @twitter by @mdo and @fat.
|
||||
* Date: Mon Oct 17 12:44:52 PDT 2011
|
||||
* Date: Mon Oct 17 14:16:58 PDT 2011
|
||||
*/
|
||||
/* Reset.less
|
||||
* Props to Eric Meyer (meyerweb.com) for his CSS reset file. We're using an adapted version here that cuts out some of the reset HTML elements we will never need here (i.e., dfn, samp, etc).
|
||||
|
|
@ -367,6 +367,7 @@ h5,
|
|||
h6 {
|
||||
font-weight: bold;
|
||||
color: #404040;
|
||||
text-rendering: optimizelegibility;
|
||||
}
|
||||
h1 small,
|
||||
h2 small,
|
||||
|
|
@ -388,7 +389,7 @@ h2 {
|
|||
line-height: 36px;
|
||||
}
|
||||
h2 small {
|
||||
font-size: 14px;
|
||||
font-size: 18px;
|
||||
}
|
||||
h3 {
|
||||
line-height: 27px;
|
||||
|
|
@ -466,6 +467,12 @@ em {
|
|||
.muted {
|
||||
color: #bfbfbf;
|
||||
}
|
||||
abbr {
|
||||
font-size: 90%;
|
||||
text-transform: uppercase;
|
||||
border-bottom: 1px dotted #ddd;
|
||||
cursor: help;
|
||||
}
|
||||
blockquote {
|
||||
margin-bottom: 18px;
|
||||
border-left: 5px solid #eee;
|
||||
|
|
|
|||
|
|
@ -63,9 +63,9 @@ a{color:#0069d6;text-decoration:none;line-height:inherit;font-weight:inherit;}a:
|
|||
.offset10{margin-left:820px;}
|
||||
.offset11{margin-left:900px;}
|
||||
p{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px;line-height:18px;margin-bottom:9px;}p small{font-size:11px;color:#bfbfbf;}
|
||||
h1,h2,h3,h4,h5,h6{font-weight:bold;color:#404040;}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{color:#bfbfbf;}
|
||||
h1,h2,h3,h4,h5,h6{font-weight:bold;color:#404040;text-rendering:optimizelegibility;}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small{color:#bfbfbf;}
|
||||
h1{font-size:30px;line-height:36px;}h1 small{font-size:18px;}
|
||||
h2{font-size:24px;line-height:36px;}h2 small{font-size:14px;}
|
||||
h2{font-size:24px;line-height:36px;}h2 small{font-size:18px;}
|
||||
h3{line-height:27px;font-size:18px;}h3 small{font-size:14px;}
|
||||
h4{font-size:16px;line-height:36px;}h4 small{font-size:12px;}
|
||||
h5{font-size:14px;line-height:18px;}
|
||||
|
|
@ -83,6 +83,7 @@ hr{margin:20px 0 19px;border:0;border-bottom:1px solid #eee;}
|
|||
strong{font-style:inherit;font-weight:bold;}
|
||||
em{font-style:italic;font-weight:inherit;line-height:inherit;}
|
||||
.muted{color:#bfbfbf;}
|
||||
abbr{font-size:90%;text-transform:uppercase;border-bottom:1px dotted #ddd;cursor:help;}
|
||||
blockquote{margin-bottom:18px;border-left:5px solid #eee;padding-left:15px;}blockquote p{font-size:14px;font-weight:300;line-height:18px;margin-bottom:0;}
|
||||
blockquote small{display:block;font-size:12px;font-weight:300;line-height:18px;color:#bfbfbf;}blockquote small:before{content:'\2014 \00A0';}
|
||||
address{display:block;line-height:18px;margin-bottom:18px;}
|
||||
|
|
|
|||
|
|
@ -307,6 +307,11 @@ pre.prettyprint {
|
|||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* Make tables spaced out a bit more */
|
||||
h2 + table {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* Responsive Docs
|
||||
-------------------------------------------------- */
|
||||
@media (max-width: 480px) {
|
||||
|
|
|
|||
349
docs/index.html
349
docs/index.html
|
|
@ -406,90 +406,130 @@
|
|||
<h1>Typography <small>Headings, paragraphs, lists, and other inline type elements</small></h1>
|
||||
</div>
|
||||
|
||||
<h2>Headings & body copy</h2>
|
||||
|
||||
<!-- Headings & Paragraph Copy -->
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<h2>Headings & copy</h2>
|
||||
<p>A standard typographic hierarchy for structuring your webpages.</p>
|
||||
<h3>Typographic scale</h3>
|
||||
<p>The entire typographic grid is based on two Less variables in our preboot.less file: <code>@baseFontSize</code> and <code>@baseLineHeight</code>. The first is the base font-size used throughout and the second is the base line-height.</p>
|
||||
<p>We use those variables, and some math, to create the margins, paddings, and line-heights of all our type and more.</p>
|
||||
</div>
|
||||
<div class="span4">
|
||||
<h1>h1. Heading 1</h1>
|
||||
<h2>h2. Heading 2</h2>
|
||||
<h3>h3. Heading 3</h3>
|
||||
<h4>h4. Heading 4</h4>
|
||||
<h5>h5. Heading 5</h5>
|
||||
<h6>h6. Heading 6</h6>
|
||||
<h3>Example body text</h3>
|
||||
<p>Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
|
||||
<p>Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec sed odio dui.</p>
|
||||
</div>
|
||||
<div class="span4">
|
||||
<h3>Example paragraph</h3>
|
||||
<p>Nullam quis risus eget urna mollis ornare vel eu leo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
|
||||
<h1>Example heading <small>Has sub-heading…</small></h1>
|
||||
<div class="well">
|
||||
<h1>h1. Heading 1</h1>
|
||||
<h2>h2. Heading 2</h2>
|
||||
<h3>h3. Heading 3</h3>
|
||||
<h4>h4. Heading 4</h4>
|
||||
<h5>h5. Heading 5</h5>
|
||||
<h6>h6. Heading 6</h6>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Misc Elements -->
|
||||
<h2>Emphasis, address, and abbreviation</h2>
|
||||
<table class="zebra-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Element</th>
|
||||
<th>Description</th>
|
||||
<th>Usage</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code><strong></code>
|
||||
</td>
|
||||
<td>
|
||||
For emphasizing a snippet of text with <strong>important</strong>
|
||||
</td>
|
||||
<td>
|
||||
<span class="muted">None</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><em></code>
|
||||
</td>
|
||||
<td>
|
||||
For emphasizing a snippet of text with <em>stress</em>
|
||||
</td>
|
||||
<td>
|
||||
<span class="muted">None</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><abbr></code>
|
||||
</td>
|
||||
<td>
|
||||
Wraps abbreviations and acronyms to show the expanded version on hover
|
||||
</td>
|
||||
<td>
|
||||
Include optional <code>title</code> for expanded text
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><address></code>
|
||||
</td>
|
||||
<td>
|
||||
For contact information for its nearest ancestor or the entire body of work
|
||||
</td>
|
||||
<td>
|
||||
Preserve formatting by ending all lines with <code><br></code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
<h2>Misc. elements</h2>
|
||||
<p>Using emphasis, addresses, & abbreviations</p>
|
||||
<p>
|
||||
<code><strong></code>
|
||||
<code><em></code>
|
||||
<code><address></code>
|
||||
<code><abbr></code>
|
||||
</p>
|
||||
</div>
|
||||
<div class="span9">
|
||||
<h3>When to use</h3>
|
||||
<p>Emphasis tags (<code><strong></code> and <code><em></code>) should be used to indicate additional importance or emphasis of a word or phrase relative to its surrounding copy. Use <code><strong></code> for importance and <code><em></code> for <em>stress</em> emphasis.</p>
|
||||
<h3>Emphasis in a paragraph</h3>
|
||||
<div class="span4">
|
||||
<h3>Using emphasis</h3>
|
||||
<p><a href="#">Fusce dapibus</a>, <strong>tellus ac cursus commodo</strong>, <em>tortor mauris condimentum nibh</em>, ut fermentum massa justo sit amet risus. Maecenas faucibus mollis interdum. Nulla vitae elit libero, a pharetra augue.</p>
|
||||
<p><strong>Note:</strong> It's still okay to use <code><b></code> and <code><i></code> tags in HTML5 and they don't have to be styled bold and italic, respectively (although if there is a more semantic element, use it). <code><b></code> is meant to highlight words or phrases without conveying additional importance, while <code><i></code> is mostly for voice, technical terms, etc.</p>
|
||||
<h3>Addresses</h3>
|
||||
<p>The <code><address></code> element is used for contact information for its nearest ancestor, or the entire body of work. Here are two examples of how it could be used:</p>
|
||||
|
||||
<div class="row">
|
||||
<div class="span4">
|
||||
<address>
|
||||
<strong>Twitter, Inc.</strong><br>
|
||||
795 Folsom Ave, Suite 600<br>
|
||||
San Francisco, CA 94107<br>
|
||||
<abbr title="Phone">P:</abbr> (123) 456-7890
|
||||
</address>
|
||||
</div>
|
||||
<div class="span4">
|
||||
<address>
|
||||
<strong>Full Name</strong><br>
|
||||
<a mailto="">first.last@gmail.com</a>
|
||||
</address>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p><strong>Note:</strong> Each line in an <code><address></code> must end with a line-break (<code><br></code>) or be wrapped in a block-level tag (e.g., <code><p></code>) to properly structure the content.</p>
|
||||
<h3>Abbreviations</h3>
|
||||
<p>For abbreviations and acronyms, use the <code><abbr></code> tag (<code><acronym></code> is deprecated in <abbr title="HyperText Markup Langugage 5">HTML5</abbr>). Put the shorthand form within the tag and set a title for the complete name.</p>
|
||||
<p><strong>Note:</strong> Feel free to use <code><b></code> and <code><i></code> in HTML5, but their usage has changed a bit. <code><b></code> is meant to highlight words or phrases without conveying additional importance while <code><i></code> is mostly for voice, technical terms, etc.</p>
|
||||
</div>
|
||||
</div><!-- /row -->
|
||||
<div class="span4">
|
||||
<h3>Example addresses</h3>
|
||||
<p>Here are two examples of how the <code><address></code> tag can be used:</p>
|
||||
<address>
|
||||
<strong>Twitter, Inc.</strong><br>
|
||||
795 Folsom Ave, Suite 600<br>
|
||||
San Francisco, CA 94107<br>
|
||||
<abbr title="Phone">P:</abbr> (123) 456-7890
|
||||
</address>
|
||||
<address>
|
||||
<strong>Full Name</strong><br>
|
||||
<a mailto="#">first.last@gmail.com</a>
|
||||
</address>
|
||||
</div>
|
||||
<div class="span4">
|
||||
<h3>Example abbreviations</h3>
|
||||
<p>Abbreviations are styled with uppercase text and a light dotted bottom border. They also have a help cursor on hover so users have extra indication something will be shown on hover.</p>
|
||||
<p><abbr title="HyperText Markup Language">HTML</abbr> is the best thing since sliced bread.</p>
|
||||
<p>An abbreviation of the word attribute is <abbr title="attribute">attr</abbr>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<!-- Blockquotes -->
|
||||
<h2>Blockquotes</h2>
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
<h2>Blockquotes</h2>
|
||||
<p>
|
||||
<code><blockquote></code>
|
||||
<code><p></code>
|
||||
<code><small></code>
|
||||
</p>
|
||||
</div>
|
||||
<div class="span9">
|
||||
<h3>How to quote</h3>
|
||||
<div class="span5">
|
||||
<p>To include a blockquote, wrap <code><blockquote></code> around <code><p></code> and <code><small></code> tags. Use the <code><small></code> element to cite your source and you'll get an em dash <code>&mdash;</code> before it.</p>
|
||||
<blockquote>
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante venenatis dapibus posuere velit aliquet.</p>
|
||||
<small>Dr. Julius Hibbert</small>
|
||||
</blockquote>
|
||||
</div>
|
||||
<div class="span7">
|
||||
<pre class="prettyprint linenums">
|
||||
<blockquote>
|
||||
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante venenatis dapibus posuere velit aliquet.</p>
|
||||
|
|
@ -497,8 +537,9 @@
|
|||
</blockquote>
|
||||
</pre>
|
||||
</div>
|
||||
</div><!-- /row -->
|
||||
</div>
|
||||
|
||||
<!-- Lists -->
|
||||
<h2>Lists</h2>
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
|
|
@ -522,7 +563,7 @@
|
|||
</ul>
|
||||
</div>
|
||||
<div class="span3">
|
||||
<h4>Unstyled <code><.unstyled></code></h4>
|
||||
<h4>Unstyled <code><ul.unstyled></code></h4>
|
||||
<ul class="unstyled">
|
||||
<li>Lorem ipsum dolor sit amet</li>
|
||||
<li>Consectetur adipiscing elit</li>
|
||||
|
|
@ -570,120 +611,96 @@
|
|||
|
||||
|
||||
<!-- Code -->
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
<h2>Code</h2>
|
||||
<p>
|
||||
<code><code></code>
|
||||
<code><pre></code>
|
||||
</p>
|
||||
<p>Pimp your code in style with two simple tags. For even more awesomeness through javascript, drop in Google's code prettify library and you're set.</p>
|
||||
</div>
|
||||
<div class="span9">
|
||||
<h3>Presenting code</h3>
|
||||
<p>Code, blocks of or just snippets inline, can be displayed with style just by wrapping in the right tag. For blocks of code spanning multiple lines, use the <code><pre></code> element. For inline code, use the <code><code></code> element.</p>
|
||||
<table class="zebra-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width: 190px;">Element</th>
|
||||
<th>Result</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code><code></code></td>
|
||||
<td>In a line of text like this, your wrapped code will look like this <code><html></code> element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><pre></code></td>
|
||||
<td>
|
||||
|
||||
<h2>Code <small>Inline and block</small></h2>
|
||||
<table class="zebra-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width: 190px;">Element</th>
|
||||
<th>Result</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code><code></code></td>
|
||||
<td>In a line of text like this, your wrapped code will look like this <code><html></code> element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><pre></code></td>
|
||||
<td>
|
||||
<pre><div>
|
||||
<h1>Heading</h1>
|
||||
<p>Something right here...</p>
|
||||
</div></pre>
|
||||
<p><strong>Note:</strong> Be sure to keep code within <code>pre</code> tags as close to the left as possible; it will render all tabs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><pre class="prettyprint"></code></td>
|
||||
<td>
|
||||
<p>Using the google-code-prettify library, you're blocks of code get a slightly different visual style and automatic syntax highlighting.</p>
|
||||
<p><strong>Note:</strong> Be sure to keep code within <code>pre</code> tags as close to the left as possible; it will render all tabs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code><pre class="prettyprint"></code></td>
|
||||
<td>
|
||||
<p>Using the google-code-prettify library, you're blocks of code get a slightly different visual style and automatic syntax highlighting.</p>
|
||||
<pre class="prettyprint"><div>
|
||||
<h1>Heading</h1>
|
||||
<p>Something right here...</p>
|
||||
</div></pre>
|
||||
<p><a href="http://code.google.com/p/google-code-prettify/">Download google-code-prettify</a> and view the readme for <a href="http://google-code-prettify.googlecode.com/svn/trunk/README.html">how to use</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div><!-- /row -->
|
||||
<p><a href="http://code.google.com/p/google-code-prettify/">Download google-code-prettify</a> and view the readme for <a href="http://google-code-prettify.googlecode.com/svn/trunk/README.html">how to use</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<!-- Labels -->
|
||||
<div class="row">
|
||||
<div class="span3">
|
||||
<h2>Inline labels</h2>
|
||||
<p>
|
||||
<code><span class="label"></code>
|
||||
</p>
|
||||
<p>Call attention to or flag any phrase in your body text.</p>
|
||||
</div>
|
||||
<div class="span9">
|
||||
<h3>Label anything</h3>
|
||||
<p>Ever needed one of those fancy <span class="label success">New!</span> or <span class="label important">Important</span> flags when writing code? Well, now you have them. Here's what's included by default:</p>
|
||||
<table class="zebra-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width: 50%;">Label</th>
|
||||
<th>Result</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code><span class="label">Default</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<span class="label">Default</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><span class="label success">New</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<span class="label success">New</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><span class="label warning">Warning</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<span class="label warning">Warning</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><span class="label important">Important</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<span class="label important">Important</span>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code><span class="label notice">Notice</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<span class="label notice">Notice</span>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div><!-- /row -->
|
||||
<h2>Inline labels <small>for special attention</small></h2>
|
||||
<table class="zebra-striped">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width: 190px;">Labels</th>
|
||||
<th>Markup</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<span class="label">Default</span>
|
||||
</td>
|
||||
<td>
|
||||
<code><span class="label">Default</span></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<span class="label success">New</span>
|
||||
</td>
|
||||
<td>
|
||||
<code><span class="label success">New</span></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<span class="label warning">Warning</span>
|
||||
</td>
|
||||
<td>
|
||||
<code><span class="label warning">Warning</span></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<span class="label important">Important</span>
|
||||
</td>
|
||||
<td>
|
||||
<code><span class="label important">Important</span></code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<span class="label notice">Notice</span>
|
||||
</td>
|
||||
<td>
|
||||
<code><span class="label notice">Notice</span></code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</section>
|
||||
|
||||
|
|
|
|||
|
|
@ -24,6 +24,7 @@ p {
|
|||
h1, h2, h3, h4, h5, h6 {
|
||||
font-weight: bold;
|
||||
color: @grayDark;
|
||||
text-rendering: optimizelegibility;
|
||||
small {
|
||||
color: @grayLight;
|
||||
}
|
||||
|
|
@ -39,7 +40,7 @@ h2 {
|
|||
font-size: 24px;
|
||||
line-height: @baseLineHeight * 2;
|
||||
small {
|
||||
font-size: 14px;
|
||||
font-size: 18px;
|
||||
}
|
||||
}
|
||||
h3 {
|
||||
|
|
@ -134,6 +135,14 @@ em {
|
|||
color: @grayLight;
|
||||
}
|
||||
|
||||
// Abbreviations and acronyms
|
||||
abbr {
|
||||
font-size: 90%;
|
||||
text-transform: uppercase;
|
||||
border-bottom: 1px dotted #ddd;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
// Blockquotes
|
||||
blockquote {
|
||||
margin-bottom: @baseLineHeight;
|
||||
|
|
|
|||
Loading…
Reference in New Issue