From b455ed8def8c82acaabf79c74e8899ee9139b6b2 Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 29 May 2015 01:58:52 -0700 Subject: [PATCH] add markdown toc stuff --- docs/components/alerts.md | 5 +++++ docs/components/badges.md | 5 +++++ docs/components/button-dropdown.md | 5 +++++ docs/components/button-group.md | 5 +++++ docs/components/buttons.md | 5 +++++ docs/components/card.md | 24 ++++++++---------------- docs/components/carousel.md | 5 +++++ docs/components/code.md | 5 +++++ docs/components/collapse.md | 5 +++++ docs/components/dropdowns.md | 5 +++++ docs/components/forms.md | 5 +++++ docs/components/images.md | 5 +++++ docs/components/input-group.md | 5 +++++ docs/components/list-group.md | 17 +++++++++++------ docs/components/modal.md | 5 +++++ docs/components/navbar.md | 5 +++++ docs/components/navs.md | 5 +++++ docs/components/pagination.md | 5 +++++ docs/components/popovers.md | 5 +++++ docs/components/progress.md | 5 +++++ docs/components/reboot.md | 5 +++++ docs/components/scrollspy.md | 5 +++++ docs/components/tables.md | 5 +++++ docs/components/tooltips.md | 5 +++++ docs/components/typography.md | 5 +++++ docs/components/utilities.md | 5 +++++ docs/getting-started/compiling.md | 17 +++++++++++------ docs/getting-started/contents.md | 9 +++++++-- docs/getting-started/download.md | 20 ++++++++++++-------- docs/getting-started/javascript.md | 23 ++++++++++++++--------- docs/getting-started/support.md | 5 +++++ docs/layout/flexbox.md | 5 +++++ docs/layout/grid.md | 5 +++++ docs/layout/media.md | 13 +++++++++---- docs/layout/scaffolding.md | 13 +++++++++---- 35 files changed, 216 insertions(+), 55 deletions(-) diff --git a/docs/components/alerts.md b/docs/components/alerts.md index a7d43400ad..b3a2e1b00c 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -5,6 +5,11 @@ title: Alerts Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Examples Alerts are available for any length of text, as well as an optional dismiss button. For proper styling, use one of the four **required** contextual classes (e.g., `.alert-success`). For inline dismissal, use the [alerts jQuery plugin](#dismissing). diff --git a/docs/components/badges.md b/docs/components/badges.md index 0828f151d2..324053fec3 100644 --- a/docs/components/badges.md +++ b/docs/components/badges.md @@ -5,6 +5,11 @@ title: Badges Badges are indicators for new or unread activity and include support for the active states of our [navigation components](/components/navs/), links, buttons, and more. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + {% example html %} Inbox 42 {% endexample %} diff --git a/docs/components/button-dropdown.md b/docs/components/button-dropdown.md index 1e44d7853f..2e7b9d8dea 100644 --- a/docs/components/button-dropdown.md +++ b/docs/components/button-dropdown.md @@ -11,6 +11,11 @@ Use any button to trigger a dropdown menu by placing it within a `.btn-group` an Button dropdowns require the [dropdown plugin](../javascript/#dropdowns) to be included in your version of Bootstrap. {% endcallout %} +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ### Single button dropdowns Turn a button into a dropdown toggle with some basic markup changes. diff --git a/docs/components/button-group.md b/docs/components/button-group.md index 9f223c7de9..979dac1c1b 100644 --- a/docs/components/button-group.md +++ b/docs/components/button-group.md @@ -5,6 +5,11 @@ title: Button group Group a series of buttons together on a single line with the button group. Add on optional JavaScript radio and checkbox style behavior with [our buttons plugin](../javascript/#buttons). +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + {% callout warning %} #### Tooltips & popovers in button groups require special setting diff --git a/docs/components/buttons.md b/docs/components/buttons.md index 62727fba49..4d2fc47be3 100644 --- a/docs/components/buttons.md +++ b/docs/components/buttons.md @@ -5,6 +5,11 @@ title: Buttons Buttons are used to execute actions in forms, dialogs, and more. Use any of the available button classes to quickly create a styled button. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Examples Bootstrap includes six predefined button styles, each serving its own semantic purpose. diff --git a/docs/components/card.md b/docs/components/card.md index 1a7a2aaca8..8c5bcc9b4d 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -7,6 +7,11 @@ A **card** is a flexible and extensible content container. It includes options f If you're familiar with Bootstrap 3, cards replace our old panels, wells, and thumbnails. Similar functionality to those components is available as modifier classes for cards. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Example Cards require a small amount of markup and classes to provide you with as much control as possible. These classes and markup are flexible though and can typically be remixed and extended with ease. @@ -154,7 +159,9 @@ Add an optional header and/or footer within a card. Go somewhere +{% endexample %} +{% example html %}
Quote @@ -182,21 +189,6 @@ Add an optional header and/or footer within a card. 2 days ago
- -
-
- Quote -
-
-
-

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

-
Someone famous in Source Title
-
-
-
- 2 days ago -
-
{% endexample %} ## Image caps @@ -228,7 +220,7 @@ Turn an image into a card background and overlay your card's text. Depending on {% example html %}
- Card image + Card image

Card title

This is a wider card with supporting text below as a natural lead-in to additional content. This content is a little bit longer.

diff --git a/docs/components/carousel.md b/docs/components/carousel.md index 138358f37a..0beb89f1c3 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -5,6 +5,11 @@ title: Carousel A slideshow component for cycling through elements—images or slides of text—like a carousel. **Nested carousels are not supported.** +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Example {% example html %} diff --git a/docs/components/code.md b/docs/components/code.md index 423987d92f..9c7f92bae1 100644 --- a/docs/components/code.md +++ b/docs/components/code.md @@ -5,6 +5,11 @@ title: Code Styles for inline code snippets and longer, multiline blocks of code. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Inline code Wrap inline snippets of code with `code`. Be sure to escape HTML angle brackets. diff --git a/docs/components/collapse.md b/docs/components/collapse.md index e61fb82b52..e3eff9e69c 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -5,6 +5,11 @@ title: Collapse Flexible plugin that utilizes a handful of classes for easy toggle behavior. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + {% callout danger %} #### Plugin dependency diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index a24093d9a1..f806f92568 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -5,6 +5,11 @@ title: Dropdowns Toggleable, contextual menu for displaying lists of links. Made interactive with the included dropdown JavaScript plugin. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Example Wrap the dropdown's trigger and the dropdown menu within `.dropdown`, or another element that declares `position: relative;`. Then add the menu's HTML. diff --git a/docs/components/forms.md b/docs/components/forms.md index b2e2263b62..2c4e3979d3 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -5,6 +5,11 @@ title: Forms Bootstrap provides several form control styles, layout options, and custom components for creating a wide variety of forms. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Form controls Bootstrap's form controls expand on [our Rebooted form styles](/components/reboot/#forms) with classes. Use these classes to opt into their customized displays for a more consistent rendering across browsers and devices. The example form below demonstrates common HTML form elements that receive updated styles from Bootstrap with additional classes. diff --git a/docs/components/images.md b/docs/components/images.md index dca37a5e84..afcf1c9d2f 100644 --- a/docs/components/images.md +++ b/docs/components/images.md @@ -5,6 +5,11 @@ title: Images Opt your images into responsive behavior (so they never become larger than their parent elements) and add lightweight styles to them—all via classes. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Responsive images Images in Bootstrap are made responsive with `.img-responsive`. `max-width: 100%;` and `height: auto;` are applied to the image so that it scales with the parent element. diff --git a/docs/components/input-group.md b/docs/components/input-group.md index c89b44e87b..3c933b862f 100644 --- a/docs/components/input-group.md +++ b/docs/components/input-group.md @@ -5,6 +5,11 @@ title: Input group Easily extend form controls by adding text, buttons, or button groups on either side of textual ``s. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Basic example Place one add-on or button on either side of an input. You may also place one on both sides of an input. **We do not support multiple add-ons on a single side, nor multiple form-controls in a single input group.** diff --git a/docs/components/list-group.md b/docs/components/list-group.md index 6324032f53..6e6faf75f7 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -5,7 +5,12 @@ title: List group List groups are a flexible and powerful component for displaying not only simple lists of elements, but complex ones with custom content. -

Basic example

+## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + +## Basic example

The most basic list group is simply an unordered list with list items, and the proper classes. Build upon it with the options that follow, or your own CSS as needed.

{% example html %} @@ -18,7 +23,7 @@ List groups are a flexible and powerful component for displaying not only simple {% endexample %} -### Badges +## Badges Add the badges component to any list group item and it will automatically be positioned on the right. @@ -39,7 +44,7 @@ Add the badges component to any list group item and it will automatically be pos {% endexample %} -### Linked items +## Linked items Linkify list group items by using anchor tags instead of list items (that also means a parent `
` instead of an `
    `). No need for individual parents around each element. @@ -55,7 +60,7 @@ Linkify list group items by using anchor tags instead of list items (that also m
{% endexample %} -### Disabled items +## Disabled items Add `.disabled` to a `.list-group-item` to gray it out to appear disabled. @@ -71,7 +76,7 @@ Add `.disabled` to a `.list-group-item` to gray it out to appear disabled.
{% endexample %} -### Contextual classes +## Contextual classes Use contextual classes to style list items, default or linked. Also includes `.active` state. @@ -90,7 +95,7 @@ Use contextual classes to style list items, default or linked. Also includes `.a
{% endexample %} -### Custom content +## Custom content Add nearly any HTML within, even for linked list groups like the one below. diff --git a/docs/components/modal.md b/docs/components/modal.md index b80b41405b..80d0820fc7 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -5,6 +5,11 @@ title: Modal Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + **Due to how HTML5 defines its semantics, the `autofocus` HTML attribute has no effect in Bootstrap modals.** To achieve the same effect, use some custom JavaScript: {% highlight js %} diff --git a/docs/components/navbar.md b/docs/components/navbar.md index a28ed37147..1e53de16b5 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -5,6 +5,11 @@ title: Navbar The navbar is a simple wrapper for positioning branding, navigation, and other elements. It's easily extensible and with the help of our collapse plugin it can easily integrate offscreen content. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ### Basics Here's what you need to know before getting started with the navbar: diff --git a/docs/components/navs.md b/docs/components/navs.md index b69d063a7d..9096dcdce8 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -5,6 +5,11 @@ title: Navs Navigation available in Bootstrap share general markup and styles, from the base `.nav` class to the active and disabled states. Swap modifier classes to switch between each style. +## Contents + +* Will be replaced with the ToC, excluding the "Contents" header +{:toc} + ## Regarding accessibility If you are using navs to provide a navigation bar, be sure to add a `role="navigation"` to the most logical parent container of the `