From 83c8bfa30d4d906ff7f2e37314e99e1098eb9bce Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Fri, 25 Nov 2016 14:01:06 -0800 Subject: [PATCH] Fixes #21195: Add more table of contents to pages with longer contents --- docs/about/brand.md | 5 +++++ docs/components/badge.md | 5 +++++ docs/getting-started/accessibility.md | 5 +++++ docs/getting-started/build-tools.md | 5 +++++ docs/getting-started/download.md | 11 ++++++++--- docs/layout/overview.md | 5 +++++ docs/layout/responsive-utilities.md | 5 +++++ docs/utilities/spacing.md | 5 +++++ docs/utilities/typography.md | 5 +++++ 9 files changed, 48 insertions(+), 3 deletions(-) diff --git a/docs/about/brand.md b/docs/about/brand.md index 3687bdceb0..601051c2f8 100644 --- a/docs/about/brand.md +++ b/docs/about/brand.md @@ -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. diff --git a/docs/components/badge.md b/docs/components/badge.md index 55a6df4f7d..4e4bafcde0 100644 --- a/docs/components/badge.md +++ b/docs/components/badge.md @@ -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. diff --git a/docs/getting-started/accessibility.md b/docs/getting-started/accessibility.md index 9b2fc37db1..a13ea286ef 100644 --- a/docs/getting-started/accessibility.md +++ b/docs/getting-started/accessibility.md @@ -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 AT. +## 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. diff --git a/docs/getting-started/build-tools.md b/docs/getting-started/build-tools.md index e629616634..a48304ebcc 100644 --- a/docs/getting-started/build-tools.md +++ b/docs/getting-started/build-tools.md @@ -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: diff --git a/docs/getting-started/download.md b/docs/getting-started/download.md index a8168d9fa7..4a1b74a9b6 100644 --- a/docs/getting-started/download.md +++ b/docs/getting-started/download.md @@ -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. Download Bootstrap -### 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). Download source -### Bootstrap CDN +## Bootstrap CDN Skip the download and use the Bootstrap CDN to deliver Bootstrap's compiled CSS and JS to your project. diff --git a/docs/layout/overview.md b/docs/layout/overview.md index e4d6bc49ed..758854b8aa 100644 --- a/docs/layout/overview.md +++ b/docs/layout/overview.md @@ -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). diff --git a/docs/layout/responsive-utilities.md b/docs/layout/responsive-utilities.md index 6a7a1bb091..69f6ae1be9 100644 --- a/docs/layout/responsive-utilities.md +++ b/docs/layout/responsive-utilities.md @@ -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. diff --git a/docs/utilities/spacing.md b/docs/utilities/spacing.md index 91dab4f02d..0a51329414 100644 --- a/docs/utilities/spacing.md +++ b/docs/utilities/spacing.md @@ -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. diff --git a/docs/utilities/typography.md b/docs/utilities/typography.md index c5628dad1b..7db133d054 100644 --- a/docs/utilities/typography.md +++ b/docs/utilities/typography.md @@ -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.