new toc in utils and about and extend

This commit is contained in:
Mark Otto 2017-05-28 11:25:59 -07:00
parent c72cc98bd5
commit f682dec5c2
17 changed files with 37 additions and 41 deletions

View File

@ -3,6 +3,7 @@ layout: docs
title: Brand guidelines title: Brand guidelines
description: Documentation and examples for Bootstrap's logo and brand usage guidelines. description: Documentation and examples for Bootstrap's logo and brand usage guidelines.
group: about group: about
toc: true
--- ---
Have a need for Bootstrap's brand resources? Great! We have only a few guidelines we follow, and in turn ask you to follow as well. These guidelines were inspired by MailChimp's [Brand Assets](https://mailchimp.com/about/brand-assets/). Have a need for Bootstrap's brand resources? Great! We have only a few guidelines we follow, and in turn ask you to follow as well. These guidelines were inspired by MailChimp's [Brand Assets](https://mailchimp.com/about/brand-assets/).

View File

@ -1,6 +1,7 @@
--- ---
layout: docs layout: docs
title: Icons title: Icons
description: Guidance and suggestions for using external icon libraries with Bootstrap.
group: extend group: extend
--- ---

View File

@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
title: Borders title: Borders
description: Use border utilities to quickly style the border and border-radius of an element. Great for images, buttons, or any other element.
group: utilities group: utilities
redirect_from: "/utilities/" redirect_from: "/utilities/"
toc: true
--- ---
Use border utilities to quickly style the `border` and `border-radius` of an element. Great for images, buttons, or any other element.
## Border ## Border
Add classes to an element to remove all borders or some borders. Add classes to an element to remove all borders or some borders.

View File

@ -1,7 +1,9 @@
--- ---
layout: docs layout: docs
title: Clearfix title: Clearfix
description: Quickly and easily clear floated content within a container by adding a clearfix utility.
group: utilities group: utilities
toc: true
--- ---
Easily clear `float`s by adding `.clearfix` **to the parent element**. Utilizes [the micro clearfix](http://nicolasgallagher.com/micro-clearfix-hack/) as popularized by Nicolas Gallagher. Can also be used as a mixin. Easily clear `float`s by adding `.clearfix` **to the parent element**. Utilizes [the micro clearfix](http://nicolasgallagher.com/micro-clearfix-hack/) as popularized by Nicolas Gallagher. Can also be used as a mixin.

View File

@ -1,10 +1,12 @@
--- ---
layout: docs layout: docs
title: Close icon title: Close icon
description: Use a generic close icon for dismissing content like modals and alerts.
group: utilities group: utilities
toc: true
--- ---
Use a generic close icon for dismissing content like modals and alerts. **Be sure to include text for screen readers**, as we've done with `aria-label`. **Be sure to include text for screen readers**, as we've done with `aria-label`.
{% example html %} {% example html %}
<button type="button" class="close" aria-label="Close"> <button type="button" class="close" aria-label="Close">

View File

@ -1,11 +1,11 @@
--- ---
layout: docs layout: docs
title: Colors title: Colors
description: Convey meaning through color with a handful of color utility classes. Includes support for styling links with hover states, too.
group: utilities group: utilities
toc: true
--- ---
Convey meaning through color with a handful of emphasis utility classes. These may also be applied to links and will darken on hover just like our default link styles.
{% example html %} {% example html %}
<p class="text-muted">Fusce dapibus, tellus ac cursus commodo, tortor mauris nibh.</p> <p class="text-muted">Fusce dapibus, tellus ac cursus commodo, tortor mauris nibh.</p>
<p class="text-primary">Nullam id dolor id nibh ultricies vehicula ut id elit.</p> <p class="text-primary">Nullam id dolor id nibh ultricies vehicula ut id elit.</p>

View File

@ -1,16 +1,11 @@
--- ---
layout: docs layout: docs
title: Display property title: Display property
description: Quickly and responsively toggle the display value of components and more with our display utilities. Includes support for some of the more common values, as well as some extras for controlling display when printing.
group: utilities group: utilities
toc: true
--- ---
Quickly and responsively toggle the `display` value of components and more with our display utilities. Includes support for some of the more common values, as well as some extras for controlling `display` when printing.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Common `display` values ## Common `display` values
The [`display` property](https://developer.mozilla.org/en-US/docs/Web/CSS/display) accepts a handful of values and we support many of them with utility classes. We purposefully don't provide every value as a utility, so here's what we support: The [`display` property](https://developer.mozilla.org/en-US/docs/Web/CSS/display) accepts a handful of values and we support many of them with utility classes. We purposefully don't provide every value as a utility, so here's what we support:

View File

@ -1,16 +1,11 @@
--- ---
layout: docs layout: docs
title: Flexbox title: Flexbox
description: Quickly manage the layout, alignment, and sizing of grid columns, navigation, components, and more with a full suite of responsive flexbox utilities. For more complex implementations, custom CSS may be necessary.
group: utilities group: utilities
toc: true
--- ---
Quickly manage the layout, alignment, and sizing of grid columns, navigation, components, and more with a full suite of responsive flexbox utilities. For more complex implementations, custom CSS may be necessary.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Enable flex behaviors ## Enable flex behaviors
Apply `display` utilities to create a flexbox container and transform **direct children elements** into flex items. Flex containers and items are able to be modified further with additional flex properties. Apply `display` utilities to create a flexbox container and transform **direct children elements** into flex items. Flex containers and items are able to be modified further with additional flex properties.

View File

@ -1,7 +1,9 @@
--- ---
layout: docs layout: docs
title: Image replacement title: Image replacement
description: Swap text for background images with the image replacement class.
group: utilities group: utilities
toc: true
--- ---
Utilize the `.text-hide` class or mixin to help replace an element's text content with a background image. Utilize the `.text-hide` class or mixin to help replace an element's text content with a background image.

View File

@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
title: Position title: Position
description: Use these shorthand utilities for quickly configuring the position of an element.
group: utilities group: utilities
toc: true
--- ---
Position utilities are helpful for quickly placing a component outside the normal document flow. Choose from a handful of fixed or sticky position classes as needed. ## Fixed top
### Fixed top
Position an element at the top of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS. Position an element at the top of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS.
@ -14,7 +14,7 @@ Position an element at the top of the viewport, from edge to edge. Be sure you u
<div class="fixed-top">...</div> <div class="fixed-top">...</div>
{% endhighlight %} {% endhighlight %}
### Fixed bottom ## Fixed bottom
Position an element at the bottom of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS. Position an element at the bottom of the viewport, from edge to edge. Be sure you understand the ramifications of fixed position in your project; you may need to add aditional CSS.
@ -22,7 +22,7 @@ Position an element at the bottom of the viewport, from edge to edge. Be sure yo
<div class="fixed-bottom">...</div> <div class="fixed-bottom">...</div>
{% endhighlight %} {% endhighlight %}
### Sticky top ## Sticky top
Position an element at the top of the viewport, from edge to edge, but only after you scroll past it. The `.sticky-top` utility uses CSS's `position: sticky`, which isn't fully supported in all browsers. Position an element at the top of the viewport, from edge to edge, but only after you scroll past it. The `.sticky-top` utility uses CSS's `position: sticky`, which isn't fully supported in all browsers.

View File

@ -1,13 +1,13 @@
--- ---
layout: docs layout: docs
title: Responsive helpers title: Responsive helpers
description: Create responsive video or slideshow embeds based on the width of the parent by creating an intrinsic ratio that scales on any device.
group: utilities group: utilities
toc: true
--- ---
## Responsive embeds ## Responsive embeds
Allow browsers to determine video or slideshow dimensions based on the width of their containing block by creating an intrinsic ratio that will properly scale on any device.
Rules are directly applied to `<iframe>`, `<embed>`, `<video>`, and `<object>` elements; optionally use an explicit descendant class `.embed-responsive-item` when you want to match the styling for other attributes. Rules are directly applied to `<iframe>`, `<embed>`, `<video>`, and `<object>` elements; optionally use an explicit descendant class `.embed-responsive-item` when you want to match the styling for other attributes.
**Pro-Tip!** You don't need to include `frameborder="0"` in your `<iframe>`s as we override that for you. **Pro-Tip!** You don't need to include `frameborder="0"` in your `<iframe>`s as we override that for you.

View File

@ -1,7 +1,9 @@
--- ---
layout: docs layout: docs
title: Screenreaders title: Screenreaders
description: Use screenreader utilities to hide elements on all devices execept screen readers.
group: utilities group: utilities
toc: true
--- ---
Hide an element to all devices **except screen readers** with `.sr-only`. Combine `.sr-only` with `.sr-only-focusable` to show the element again when it's focused (e.g. by a keyboard-only user). Can also be used as mixins. Hide an element to all devices **except screen readers** with `.sr-only`. Combine `.sr-only` with `.sr-only-focusable` to show the element again when it's focused (e.g. by a keyboard-only user). Can also be used as mixins.

View File

@ -1,12 +1,12 @@
--- ---
layout: docs layout: docs
title: Sizing title: Sizing
description: Easily make an element as wide or as tall (relative to its parent) with our width and height utilities.
group: utilities group: utilities
toc: true
--- ---
Easily make an element as wide or as tall (relative to its parent) with our width and height utilities. Includes support for `25%`, `50%`, `75%`, and `100%` by default. Width and height utilities are generated from the `$sizes` Sass map in `_variables.scss`. Includes support for `25%`, `50%`, `75%`, and `100%` by default. Modify those values as you need to generate different utilities here.
Width and height utilities are generated from the `$sizes` Sass map in `_variables.scss`. Modify those values as you need to generate different utilities here.
{% example html %} {% example html %}
<div class="w-25 p-3" style="background-color: #eee;">Width 25%</div> <div class="w-25 p-3" style="background-color: #eee;">Width 25%</div>

View File

@ -1,16 +1,15 @@
--- ---
layout: docs layout: docs
title: Spacing title: Spacing
description: Bootstrap includes a wide range of shorthand responsive margin and padding utility classes to modify an element's appearance.
group: utilities group: utilities
toc: true
--- ---
## How it works
Assign responsive-friendly `margin` or `padding` values to an element or a subset of its sides with shorthand classes. Includes support for individual properties, all properties, and vertical and horizontal properties. Classes are built from a default Sass map ranging from `.25rem` to `3rem`. Assign responsive-friendly `margin` or `padding` values to an element or a subset of its sides with shorthand classes. Includes support for individual properties, all properties, and vertical and horizontal properties. Classes are built from a default Sass map ranging from `.25rem` to `3rem`.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Notation ## Notation
Spacing utilities that apply to all breakpoints, from `xs` to `xl`, have no breakpoint abbreviation in them. This is because those classes are applied from `min-width: 0` and up, and thus are not bound by a media query. The remaining breakpoints, however, do include a breakpoint abbreviation. Spacing utilities that apply to all breakpoints, from `xs` to `xl`, have no breakpoint abbreviation in them. This is because those classes are applied from `min-width: 0` and up, and thus are not bound by a media query. The remaining breakpoints, however, do include a breakpoint abbreviation.

View File

@ -1,16 +1,11 @@
--- ---
layout: docs layout: docs
title: Typography title: Typography
description: Documentation and examples for common text utilities to control alignment, wrapping, weight, and more.
group: utilities group: utilities
toc: true
--- ---
The following utilities can be used to add additional styles to texts.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Text alignment ## Text alignment
Easily realign text to components with text alignment classes. Easily realign text to components with text alignment classes.

View File

@ -1,6 +1,7 @@
--- ---
layout: docs layout: docs
title: Vertical alignment title: Vertical alignment
description: Easily change the vertical alignment of inlie, inline-block, inline-table, and table cell elements.
group: utilities group: utilities
--- ---

View File

@ -1,6 +1,7 @@
--- ---
layout: docs layout: docs
title: Visibility title: Visibility
description: Control the visibility, without modifying the display, of elements with visibility utilities.
group: utilities group: utilities
--- ---