]> git.ipfire.org Git - thirdparty/bootstrap.git/commitdiff
new toc in utils and about and extend
authorMark Otto <markdotto@gmail.com>
Sun, 28 May 2017 18:25:59 +0000 (11:25 -0700)
committerMark Otto <markdotto@gmail.com>
Sun, 28 May 2017 18:25:59 +0000 (11:25 -0700)
17 files changed:
docs/about/brand.md
docs/extend/icons.md
docs/utilities/borders.md
docs/utilities/clearfix.md
docs/utilities/close-icon.md
docs/utilities/colors.md
docs/utilities/display.md
docs/utilities/flexbox.md
docs/utilities/image-replacement.md
docs/utilities/position.md
docs/utilities/responsive-helpers.md
docs/utilities/screenreaders.md
docs/utilities/sizing.md
docs/utilities/spacing.md
docs/utilities/typography.md
docs/utilities/vertical-align.md
docs/utilities/visibility.md

index 32c40b9c4de1fd939dc94cdceeeb0847cd83b13e..5fdc06eb5cd151be83f8d172e8f9dd497a74a4cd 100644 (file)
@@ -3,6 +3,7 @@ layout: docs
 title: Brand guidelines
 description: Documentation and examples for Bootstrap's logo and brand usage guidelines.
 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/).
index c619ed2cea40f79e42a1e3093f31dde4ed2f17c5..3b4aea3eb294229df40d411a5d77c11351ea4f81 100644 (file)
@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Icons
+description: Guidance and suggestions for using external icon libraries with Bootstrap.
 group: extend
 ---
 
index 1f092c36afbc8529560463c154afeaae01e54368..8bf3f467403b2c6680cdd5aeea3067fc9b16c7ac 100644 (file)
@@ -1,12 +1,12 @@
 ---
 layout: docs
 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
 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
 
 Add classes to an element to remove all borders or some borders.
index 49410df0988305254f8eb04dcc9f6cb77061c1e7..5b5727b1170bb1c1f0d276d9b1d81b1bbf28780b 100644 (file)
@@ -1,7 +1,9 @@
 ---
 layout: docs
 title: Clearfix
+description: Quickly and easily clear floated content within a container by adding a clearfix utility.
 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.
index 5ec456bccd1c1c9a778e65fa913dbbd3fa40e188..4619132de5ade8774c62ab0214648fd62121c178 100644 (file)
@@ -1,10 +1,12 @@
 ---
 layout: docs
 title: Close icon
+description: Use a generic close icon for dismissing content like modals and alerts.
 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 %}
 <button type="button" class="close" aria-label="Close">
index b114d74fe59278c239cf66b61fcf7d27995eda2a..80e096cf95292a82672fbb18be2dea5c6279b7b9 100644 (file)
@@ -1,11 +1,11 @@
 ---
 layout: docs
 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
+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 %}
 <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>
index 27f70e0b2aaa331c9671439e2b6c9c9ead68524e..86c74119054c0a2e6128cb3ea50fc593162c96c1 100644 (file)
@@ -1,16 +1,11 @@
 ---
 layout: docs
 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
+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
 
 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:
index 9bca028486872a37f275c3a89cd1de97207d8438..bf2a6f37c0ddb86035f6bd08b04b901c886fd30b 100644 (file)
@@ -1,16 +1,11 @@
 ---
 layout: docs
 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
+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
 
 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.
index 720e7b5a92948cf5a19507e2fb1355930b153894..b11c936c4bba42132d226d05148f3d0e2165f7de 100644 (file)
@@ -1,7 +1,9 @@
 ---
 layout: docs
 title: Image replacement
+description: Swap text for background images with the image replacement class.
 group: utilities
+toc: true
 ---
 
 Utilize the `.text-hide` class or mixin to help replace an element's text content with a background image.
index 6b8268c4883a970d62308ae6bc04ab0e85a79387..93f0fd040ad9dad009c57c87d74b04e9861511bc 100644 (file)
@@ -1,12 +1,12 @@
 ---
 layout: docs
 title: Position
+description: Use these shorthand utilities for quickly configuring the position of an element.
 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.
 
@@ -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>
 {% 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.
 
@@ -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>
 {% 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.
 
index 0f1a43ee1ef217f09b5495cac6c68c062ecdce84..ae65eff6b410d573f2f65b0cd8578bb912f39d23 100644 (file)
@@ -1,13 +1,13 @@
 ---
 layout: docs
 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
+toc: true
 ---
 
 ## 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.
 
 **Pro-Tip!** You don't need to include `frameborder="0"` in your `<iframe>`s as we override that for you.
index 411f3ddb23c621ef41bdcde2f68f7224287cdf78..73743b30622a33a8212511222847add8292300be 100644 (file)
@@ -1,7 +1,9 @@
 ---
 layout: docs
 title: Screenreaders
+description: Use screenreader utilities to hide elements on all devices execept screen readers.
 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.
index eabb4653ac13e40c77b70babc81f1512a65e09d4..e2a5ed19799991c56f6fdbf22347c70601ac10a8 100644 (file)
@@ -1,12 +1,12 @@
 ---
 layout: docs
 title: Sizing
+description: Easily make an element as wide or as tall (relative to its parent) with our width and height 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`. 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`. Includes support for `25%`, `50%`, `75%`, and `100%` by default. Modify those values as you need to generate different utilities here.
 
 {% example html %}
 <div class="w-25 p-3" style="background-color: #eee;">Width 25%</div>
index fa8a0d76c93f6828d9eae65c3afc9b2abbe28781..d6d2d7b5405295060af6ae7e99eab3f5490a3f88 100644 (file)
@@ -1,15 +1,14 @@
 ---
 layout: docs
 title: Spacing
+description: Bootstrap includes a wide range of shorthand responsive margin and padding utility classes to modify an element's appearance.
 group: utilities
+toc: true
 ---
 
-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
+## How it works
 
-* Will be replaced with the ToC, excluding the "Contents" header
-{:toc}
+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`.
 
 ## Notation
 
index 5e29fd88cd65ffdf5fdce0376c9a1cb1a2706fbf..32e11335dd08e8ea047942e910d835c63f8c3273 100644 (file)
@@ -1,16 +1,11 @@
 ---
 layout: docs
 title: Typography
+description: Documentation and examples for common text utilities to control alignment, wrapping, weight, and more.
 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
 
 Easily realign text to components with text alignment classes.
index 09ae115b084e3d99ecf59d38183326a569cfced2..e684982704252aa4fb5cb447a818f777a69bc8e3 100644 (file)
@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Vertical alignment
+description: Easily change the vertical alignment of inlie, inline-block, inline-table, and table cell elements.
 group: utilities
 ---
 
index 5b7d28664be5c7e0a341a4a23bae99bf10beb0c1..9e127139fd3320b3822a7228cf1eaf76ac36ab8f 100644 (file)
@@ -1,6 +1,7 @@
 ---
 layout: docs
 title: Visibility
+description: Control the visibility, without modifying the display, of elements with visibility utilities.
 group: utilities
 ---