0
0
mirror of https://github.com/twbs/bootstrap.git synced 2025-01-17 09:52:29 +01:00

Fixes #21195: Add more table of contents to pages with longer contents

This commit is contained in:
Mark Otto 2016-11-25 14:01:06 -08:00
parent 5b151eb891
commit 83c8bfa30d
9 changed files with 48 additions and 3 deletions

View File

@ -7,6 +7,11 @@ group: about
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/).
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Mark and logo
Use either the Bootstrap mark (a capital **B**) or the standard logo (just **Bootstrap**). It should always appear in Helvetica Neue Bold. **Do not use the Twitter bird** in association with Bootstrap.

View File

@ -7,6 +7,11 @@ group: components
Small and adaptive tag for adding context to just about any content.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Example
Badges scale to match the size of the immediate parent element by using relative font sizing and `em` units.

View File

@ -7,6 +7,11 @@ group: getting-started
Bootstrap follows common web standards and—with minimal extra effort—can be used to create sites that are accessible to those using <abbr title="Assistive Technology" class="initialism">AT</abbr>.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Component requirements
Some common HTML elements are always in need for basic accessibility enhancements through `role`s and Aria attributes. Below is a list of some of the most frequently used ones.

View File

@ -7,6 +7,11 @@ group: getting-started
Bootstrap uses [Grunt](http://gruntjs.com) for its CSS and JavaScript build system and Jekyll for the written documentation. Our Gruntfile includes convenient methods for working with the framework, including compiling code, running tests, and more.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Tooling setup
To use our Gruntfile and run our documentation locally, you'll need a copy of Bootstrap's source files, Node, and Grunt. Follow these steps and you should be ready to rock:

View File

@ -7,18 +7,23 @@ group: getting-started
**Bootstrap v{{ site.current_version}}** is available for download in several ways, including some of your favorite package managers. Choose from the options below to snag just what you need.
### Bootstrap CSS and JS
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Bootstrap CSS and JS
**Download Bootstrap's ready-to-use code to easily drop into your project.** Includes compiled and minified versions of all our CSS bundles (default, flexbox-enabled, grid only, or Reboot only) and JavaScript plugins. Doesn't include documentation or source files.
<a href="{{ site.download.dist }}" class="btn btn-lg btn-bs btn-outline" onclick="ga('send', 'event', 'Getting started', 'Download', 'Download Bootstrap');">Download Bootstrap</a>
### Source files
## Source files
**Want to compile Bootstrap with your project's asset pipeline?** Choose this option to download our source Sass, JavaScript, and documentation files. Requires a Sass compiler, [Autoprefixer](https://github.com/postcss/autoprefixer), [postcss-flexbugs-fixes](https://github.com/luisrudge/postcss-flexbugs-fixes), and [some setup]({{ site.baseurl }}/getting-started/build-tools/#tooling-setup).
<a href="{{ site.download.source }}" class="btn btn-bs btn-outline" onclick="ga('send', 'event', 'Getting started', 'Download', 'Download source');">Download source</a>
### Bootstrap CDN
## Bootstrap CDN
Skip the download and use the Bootstrap CDN to deliver Bootstrap's compiled CSS and JS to your project.

View File

@ -8,6 +8,11 @@ redirect_from: "/layout/"
Bootstrap includes several components and options for laying out your project, including wrapping containers, a powerful grid system, a flexible media object, and responsive utility classes.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Containers
Containers are the most basic layout element in Bootstrap and are **required when using our grid system**. Choose from a responsive, fixed-width container (meaning its `max-width` changes at each breakpoint) or fluid-width (meaning it's `100%` wide all the time).

View File

@ -9,6 +9,11 @@ For faster mobile-friendly development, use these utility classes for showing an
Try to use these on a limited basis and avoid creating entirely different versions of the same site. Instead, use them to complement each device's presentation.
## Contents
* Will be replaced with the ToC, excluding the "Contents" header
{:toc}
## Available classes
* The `.hidden-*-up` classes hide the element when the viewport is at the given breakpoint or wider. For example, `.hidden-md-up` hides an element on medium, large, and extra-large viewports.

View File

@ -6,6 +6,11 @@ group: utilities
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
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

@ -6,6 +6,11 @@ group: utilities
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.