From d3c2fe78090d4fbc956823767f10ffbc9a8633c8 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 9 Jul 2014 23:06:16 -0700 Subject: [PATCH] rewrite type docs in markdown --- docs/_includes/css/type.html | 462 ----------------------------------- docs/_includes/css/type.md | 385 +++++++++++++++++++++++++++++ docs/css.html | 2 +- 3 files changed, 386 insertions(+), 463 deletions(-) delete mode 100644 docs/_includes/css/type.html create mode 100644 docs/_includes/css/type.md diff --git a/docs/_includes/css/type.html b/docs/_includes/css/type.html deleted file mode 100644 index 6eca026de5..0000000000 --- a/docs/_includes/css/type.html +++ /dev/null @@ -1,462 +0,0 @@ -
-

Typography

- - -

Headings

-

All HTML headings, <h1> through <h6>, are available. .h1 through .h6 classes are also available, for when you want to match the font styling of a heading but still want your text to be displayed inline.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - -

h1. Bootstrap heading

Semibold 36px

h2. Bootstrap heading

Semibold 30px

h3. Bootstrap heading

Semibold 24px

h4. Bootstrap heading

Semibold 18px
h5. Bootstrap heading
Semibold 14px
h6. Bootstrap heading
Semibold 12px
-
-{% highlight html %} -

h1. Bootstrap heading

-

h2. Bootstrap heading

-

h3. Bootstrap heading

-

h4. Bootstrap heading

-
h5. Bootstrap heading
-
h6. Bootstrap heading
-{% endhighlight %} - -

Create lighter, secondary text in any heading with a generic <small> tag or the .small class.

-
- - - - - - - - - - - - - - - - - - - - - -

h1. Bootstrap heading Secondary text

h2. Bootstrap heading Secondary text

h3. Bootstrap heading Secondary text

h4. Bootstrap heading Secondary text

h5. Bootstrap heading Secondary text
h6. Bootstrap heading Secondary text
-
-{% highlight html %} -

h1. Bootstrap heading Secondary text

-

h2. Bootstrap heading Secondary text

-

h3. Bootstrap heading Secondary text

-

h4. Bootstrap heading Secondary text

-
h5. Bootstrap heading Secondary text
-
h6. Bootstrap heading Secondary text
-{% endhighlight %} - - - -

Body copy

-

Bootstrap's global default font-size is 14px, with a line-height of 1.428. This is applied to the <body> and all paragraphs. In addition, <p> (paragraphs) receive a bottom margin of half their computed line-height (10px by default).

-
-

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.

-

Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ullamcorper nulla non metus auctor fringilla. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec ullamcorper nulla non metus auctor fringilla.

-

Maecenas sed diam eget risus varius blandit sit amet non magna. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.

-
-{% highlight html %} -

...

-{% endhighlight %} - - -

Lead body copy

-

Make a paragraph stand out by adding .lead.

-
-

Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus.

-
-{% highlight html %} -

...

-{% endhighlight %} - - -

Built with Less

-

The typographic scale is based on two Less variables in variables.less: @font-size-base and @line-height-base. The first is the base font-size used throughout and the second is the base line-height. We use those variables and some simple math to create the margins, paddings, and line-heights of all our type and more. Customize them and Bootstrap adapts.

- - -

Inline text elements

-

Marked text

-

For highlighting a run of text due to its relevance in another context, use the <mark> tag.

-
-

You can use the mark tag to highlight text.

-
-{% highlight html %} -You can use the mark tag to highlight text. -{% endhighlight %} - - -

Deleted text

-

For indicating blocks of text that have been deleted use the <del> tag.

-
-

This line of text is meant to be treated as deleted text.

-
-{% highlight html %} -This line of text is meant to be treated as deleted text. -{% endhighlight %} - -

Strikethrough text

-

For indicating blocks of text that are no longer relevant use the <s> tag.

-
-

This line of text is meant to be treated as no longer accurate.

-
-{% highlight html %} -This line of text is meant to be treated as no longer accurate. -{% endhighlight %} - -

Inserted text

-

For indicating additions to the document use the <ins> tag.

-
-

This line of text is meant to be treated as an addition to the document.

-
-{% highlight html %} -This line of text is meant to be treated as an addition to the document. -{% endhighlight %} - -

Underlined text

-

To underline text use the <u> tag.

-
-

This line of text will render as underlined

-
-{% highlight html %} -This line of text will render as underlined -{% endhighlight %} - -

Make use of HTML's default emphasis tags with lightweight styles.

- -

Small text

-

For de-emphasizing inline or blocks of text, use the <small> tag to set text at 85% the size of the parent. Heading elements receive their own font-size for nested <small> elements.

-

You may alternatively use an inline element with .small in place of any <small>.

-
-

This line of text is meant to be treated as fine print.

-
-{% highlight html %} -This line of text is meant to be treated as fine print. -{% endhighlight %} - - -

Bold

-

For emphasizing a snippet of text with a heavier font-weight.

-
-

The following snippet of text is rendered as bold text.

-
-{% highlight html %} -rendered as bold text -{% endhighlight %} - -

Italics

-

For emphasizing a snippet of text with italics.

-
-

The following snippet of text is rendered as italicized text.

-
-{% highlight html %} -rendered as italicized text -{% endhighlight %} - -
-

Alternate elements

-

Feel free to use <b> and <i> in HTML5. <b> is meant to highlight words or phrases without conveying additional importance while <i> is mostly for voice, technical terms, etc.

-
- -

Alignment classes

-

Easily realign text to components with text alignment classes.

-
-

Left aligned text.

-

Center aligned text.

-

Right aligned text.

-

Justified text.

-

No wrap text.

-
-{% highlight html %} -

Left aligned text.

-

Center aligned text.

-

Right aligned text.

-

Justified text.

-

No wrap text.

-{% endhighlight %} - -

Transformation classes

-

Transform text in components with text capitalization classes.

-
-

Lowercased text.

-

Uppercased text.

-

Capitalized text.

-
-{% highlight html %} -

Lowercased text.

-

Uppercased text.

-

Capitalized text.

-{% endhighlight %} - - -

Abbreviations

-

Stylized implementation of HTML's <abbr> element for abbreviations and acronyms to show the expanded version on hover. Abbreviations with a title attribute have a light dotted bottom border and a help cursor on hover, providing additional context on hover.

- -

Basic abbreviation

-

For expanded text on long hover of an abbreviation, include the title attribute with the <abbr> element.

-
-

An abbreviation of the word attribute is attr.

-
-{% highlight html %} -attr -{% endhighlight %} - -

Initialism

-

Add .initialism to an abbreviation for a slightly smaller font-size.

-
-

HTML is the best thing since sliced bread.

-
-{% highlight html %} -HTML -{% endhighlight %} - - - -

Addresses

-

Present contact information for the nearest ancestor or the entire body of work. Preserve formatting by ending all lines with <br>.

-
-
- Twitter, Inc.
- 795 Folsom Ave, Suite 600
- San Francisco, CA 94107
- P: (123) 456-7890 -
-
- Full Name
- first.last@example.com -
-
-{% highlight html %} -
- Twitter, Inc.
- 795 Folsom Ave, Suite 600
- San Francisco, CA 94107
- P: (123) 456-7890 -
- -
- Full Name
- first.last@example.com -
-{% endhighlight %} - - - -

Blockquotes

-

For quoting blocks of content from another source within your document.

- -

Default blockquote

-

Wrap <blockquote> around any HTML as the quote. For straight quotes, we recommend a <p>.

-
-
-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

-
-
-{% highlight html %} -
-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

-
-{% endhighlight %} - -

Blockquote options

-

Style and content changes for simple variations on a standard <blockquote>.

- -

Naming a source

-

Add a <footer> for identifying the source. Wrap the name of the source work in <cite>.

-
-
-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

-
Someone famous in Source Title
-
-
-{% highlight html %} -
-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

-
Someone famous in Source Title
-
-{% endhighlight %} - -

Alternate displays

-

Add .blockquote-reverse for a blockquote with right-aligned content.

-
-
-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

-
Someone famous in Source Title
-
-
-{% highlight html %} -
- ... -
-{% endhighlight %} - - - -

Lists

- -

Unordered

-

A list of items in which the order does not explicitly matter.

-
-
    -
  • Lorem ipsum dolor sit amet
    • -
  • Consectetur adipiscing elit
    • -
  • Integer molestie lorem at massa
    • -
  • Facilisis in pretium nisl aliquet
    • -
  • Nulla volutpat aliquam velit -
      -
    • Phasellus iaculis neque
      • -
    • Purus sodales ultricies
      • -
    • Vestibulum laoreet porttitor sem
      • -
    • Ac tristique libero volutpat at
      • -
    -
    • -
  • Faucibus porta lacus fringilla vel
    • -
  • Aenean sit amet erat nunc
    • -
  • Eget porttitor lorem
    • -
-
-{% highlight html %} - -{% endhighlight %} - -

Ordered

-

A list of items in which the order does explicitly matter.

-
-
    -
  1. Lorem ipsum dolor sit amet
    2. -
  2. Consectetur adipiscing elit
    3. -
  3. Integer molestie lorem at massa
    4. -
  4. Facilisis in pretium nisl aliquet
    5. -
  5. Nulla volutpat aliquam velit
    6. -
  6. Faucibus porta lacus fringilla vel
    7. -
  7. Aenean sit amet erat nunc
    8. -
  8. Eget porttitor lorem
    9. -
-
-{% highlight html %} -
    -
  1. ...
    2. -
-{% endhighlight %} - -

Unstyled

-

Remove the default list-style and left margin on list items (immediate children only). This only applies to immediate children list items, meaning you will need to add the class for any nested lists as well.

-
-
    -
  • Lorem ipsum dolor sit amet
    • -
  • Consectetur adipiscing elit
    • -
  • Integer molestie lorem at massa
    • -
  • Facilisis in pretium nisl aliquet
    • -
  • Nulla volutpat aliquam velit -
      -
    • Phasellus iaculis neque
      • -
    • Purus sodales ultricies
      • -
    • Vestibulum laoreet porttitor sem
      • -
    • Ac tristique libero volutpat at
      • -
    -
    • -
  • Faucibus porta lacus fringilla vel
    • -
  • Aenean sit amet erat nunc
    • -
  • Eget porttitor lorem
    • -
-
-{% highlight html %} - -{% endhighlight %} - -

Inline

-

Place all list items on a single line with display: inline-block; and some light padding.

-
-
    -
  • Lorem ipsum
    • -
  • Phasellus iaculis
    • -
  • Nulla volutpat
    • -
-
-{% highlight html %} - -{% endhighlight %} - -

Description

-

A list of terms with their associated descriptions.

-
-
-
Description lists
-
A description list is perfect for defining terms.
-
Euismod
-
Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.
-
Donec id elit non mi porta gravida at eget metus.
-
Malesuada porta
-
Etiam porta sem malesuada magna mollis euismod.
-
-
-{% highlight html %} -
-
...
-
...
-
-{% endhighlight %} - -

Horizontal description

-

Make terms and descriptions in <dl> line up side-by-side. Starts off stacked like default <dl>s, but when the navbar expands, so do these.

-
-
-
Description lists
-
A description list is perfect for defining terms.
-
Euismod
-
Vestibulum id ligula porta felis euismod semper eget lacinia odio sem nec elit.
-
Donec id elit non mi porta gravida at eget metus.
-
Malesuada porta
-
Etiam porta sem malesuada magna mollis euismod.
-
Felis euismod semper eget lacinia
-
Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
-
-
-{% highlight html %} -
-
...
-
...
-
-{% endhighlight %} - -
-

Auto-truncating

-

Horizontal description lists will truncate terms that are too long to fit in the left column with text-overflow. In narrower viewports, they will change to the default stacked layout.

-
-
diff --git a/docs/_includes/css/type.md b/docs/_includes/css/type.md new file mode 100644 index 0000000000..a16b96b81b --- /dev/null +++ b/docs/_includes/css/type.md @@ -0,0 +1,385 @@ + + +# Typography + +Bootstrap includes simple and easily customized typography across the project. In addition to the standard headings, body text, and lists, utility classes are also included. + + + + + +## Headings + +All HTML headings, `

` through `

`, are available. `.h1` through `.h6` classes are also available, for when you want to match the font styling of a heading but still want your text to be displayed inline. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

h1. Bootstrap heading

Semibold 36px

h2. Bootstrap heading

Semibold 30px

h3. Bootstrap heading

Semibold 24px

h4. Bootstrap heading

Semibold 18px
h5. Bootstrap heading
Semibold 14px
h6. Bootstrap heading
Semibold 12px
+
+ +{% highlight html %} +

h1. Bootstrap heading

+

h2. Bootstrap heading

+

h3. Bootstrap heading

+

h4. Bootstrap heading

+
h5. Bootstrap heading
+
h6. Bootstrap heading
+{% endhighlight %} + +Create lighter, secondary text in any heading with a generic `` tag or the `.small` class. + +
+ + + + + + + + + + + + + + + + + + + + + +

h1. Bootstrap heading Secondary text

h2. Bootstrap heading Secondary text

h3. Bootstrap heading Secondary text

h4. Bootstrap heading Secondary text

h5. Bootstrap heading Secondary text
h6. Bootstrap heading Secondary text
+
+ +{% highlight html %} +

h1. Bootstrap heading Secondary text

+

h2. Bootstrap heading Secondary text

+

h3. Bootstrap heading Secondary text

+

h4. Bootstrap heading Secondary text

+
h5. Bootstrap heading Secondary text
+
h6. Bootstrap heading Secondary text
+{% endhighlight %} + + + + + +## Body copy + +Bootstrap's base text is sized with global `font-size: 16px;` and `line-height: 1.5;`. This is applied to the `` and all paragraphs. + +{% example html %} +

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.

+

Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec ullamcorper nulla non metus auctor fringilla. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec ullamcorper nulla non metus auctor fringilla.

+

Maecenas sed diam eget risus varius blandit sit amet non magna. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.

+{% endexample %} + + + + + +## Lead + +Make a paragraph stand out by adding `.lead`. + +{% example html %} +

+ Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Duis mollis, est non commodo luctus. +

+{% endexample %} + + + + + +## Inline text elements + +Styling for all the common inline HTML5 elements. + +{% example html %} +

You can use the mark tag to highlight text.

+

This line of text is meant to be treated as deleted text.

+

This line of text is meant to be treated as no longer accurate.

+

This line of text is meant to be treated as an addition to the document.

+

This line of text will render as underlined

+

This line of text is meant to be treated as fine print.

+

This line rendered as bold text.

+

This line rendered as italicized text.

+

+{% endexample %} + +
+

Alternate elements

+

Feel free to use <b> and <i> in HTML5. <b> is meant to highlight words or phrases without conveying additional importance while <i> is mostly for voice, technical terms, etc.

+
+ + + + + +## Alignment classes + +Easily realign text to components with text alignment classes. + +{% example html %} +

Left aligned text.

+

Center aligned text.

+

Right aligned text.

+

Justified text.

+

No wrap text.

+{% endexample %} + + + + + +## Transformation classes + +Transform text in components with text capitalization classes. + +{% example html %} +

Lowercased text.

+

Uppercased text.

+

Capitalized text.

+{% endexample %} + + + + + +## Abbreviations + +Stylized implementation of HTML's `` element for abbreviations and acronyms to show the expanded version on hover. Abbreviations with a `title` attribute have a light dotted bottom border and a help cursor on hover, providing additional context on hover. + +### Basic abbreviation + +For expanded text on long hover of an abbreviation, include the `title` attribute with the `` element. + +{% example html %} +attr +{% endexample %} + +### Initialism + +Add `.initialism` to an abbreviation for a slightly smaller font-size. + +{% example html %} +HTML +{% endexample %} + + + + + +## Address + +Present contact information for the nearest ancestor or the entire body of work. Preserve formatting by ending all lines with `
`. + +{% example html %} +
+ Twitter, Inc.
+ 795 Folsom Ave, Suite 600
+ San Francisco, CA 94107
+ P: (123) 456-7890 +
+ +
+ Full Name
+ first.last@example.com +
+{% endexample %} + + + + + +## Blockquotes + +For quoting blocks of content from another source within your document. + +### Default blockquote + +Wrap `
` around any HTML as the quote. For straight quotes, we recommend a `

`. + +{% example html %} +

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.

+
+{% endexample %} + +### Blockquote options + +Style and content changes for simple variations on a standard `
`. + +#### Naming a source + +Add a `