chore(docs): align navigation with section titles (#6296)

jacobmllr95 · web-flow · commit 671ef4e1f309 · 2021-01-07T20:36:15.000+01:00
* chore(docs): align navigation with section titles

* Update package.json

* Use titlecase

* Use Titelcase
diff --git a/CHANGELOG-OLD.md b/CHANGELOG-OLD.md
@@ -3474,7 +3474,7 @@ Released: 2017-07-04
   ([60b1fd8](https://github.com/bootstrap-vue/bootstrap-vue/commit/60b1fd8))
 - **docs:** add root wrapper to templates
   ([ff6432d](https://github.com/bootstrap-vue/bootstrap-vue/commit/ff6432d))
-- **docs:** Fix ScrollSpy example
+- **docs:** Fix Scrollspy example
   ([0365208](https://github.com/bootstrap-vue/bootstrap-vue/commit/0365208))
 - **docs:** form-radio typo fix
   ([db6d5d7](https://github.com/bootstrap-vue/bootstrap-vue/commit/db6d5d7))
diff --git a/docs/assets/css/docs.min.css.map b/docs/assets/css/docs.min.css.map
diff --git a/src/components/alert/README.md b/src/components/alert/README.md
@@ -1,4 +1,4 @@
-# Alerts
+# Alert
 
 > Provide contextual feedback messages for typical user actions with the handful of available and
 > flexible alert messages.
diff --git a/src/components/badge/README.md b/src/components/badge/README.md
@@ -1,4 +1,4 @@
-# Badges
+# Badge
 
 > Small and adaptive tag for adding context to just about any content.
 
diff --git a/src/components/button-group/README.md b/src/components/button-group/README.md
@@ -1,10 +1,10 @@
-# Button group
+# Button Group
 
 > Group a series of buttons together on a single line with `<b-button-group>`.
 
 ## Overview
 
-Button groups are an easy way to group a series of buttons together.
+Button Groups are an easy way to group a series of buttons together.
 
 ```html
 <div>
diff --git a/src/components/button-toolbar/README.md b/src/components/button-toolbar/README.md
@@ -1,4 +1,4 @@
-# Button toolbar
+# Button Toolbar
 
 > Group a series of button-groups and/or input-groups together on a single line, with optional
 > keyboard navigation
diff --git a/src/components/button/README.md b/src/components/button/README.md
@@ -1,4 +1,4 @@
-# Buttons
+# Button
 
 > Use Bootstrap's custom `b-button` component for actions in forms, dialogs, and more. Includes
 > support for a handful of contextual variations, sizes, states, and more.
diff --git a/src/components/card/README.md b/src/components/card/README.md
@@ -1,4 +1,4 @@
-# Cards
+# Card
 
 > A card is a flexible and extensible content container. It includes options for headers and
 > footers, a wide variety of content, contextual background colors, and powerful display options.
diff --git a/src/components/dropdown/README.md b/src/components/dropdown/README.md
@@ -1,4 +1,4 @@
-# Dropdowns
+# Dropdown
 
 > Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a
 > dropdown menu format.
diff --git a/src/components/embed/README.md b/src/components/embed/README.md
@@ -1,4 +1,4 @@
-# Responsive Embeds
+# Embed
 
 > Create responsive video or slideshow embeds based on the width of the parent by creating an
 > intrinsic ratio that scales on any device.
diff --git a/src/components/form-checkbox/README.md b/src/components/form-checkbox/README.md
@@ -1,4 +1,4 @@
-# Form Checkbox Inputs
+# Form Checkbox
 
 > For cross browser consistency, `<b-form-checkbox-group>` and `<b-form-checkbox>` use Bootstrap's
 > custom checkbox input to replace the browser default checkbox input. It is built on top of
diff --git a/src/components/form-file/README.md b/src/components/form-file/README.md
@@ -1,4 +1,4 @@
-# Form File Input
+# Form File
 
 > Customized, cross-browser consistent, file input control that supports single file, multiple
 > files, and directory upload (for browsers that support directory mode).
diff --git a/src/components/form-group/README.md b/src/components/form-group/README.md
@@ -1,4 +1,4 @@
-# Form group
+# Form Group
 
 > The `<b-form-group>` component is the easiest way to add some structure to forms. Its purpose is
 > to pair form controls with a legend or label, and to provide help text and invalid/valid feedback
diff --git a/src/components/form-input/README.md b/src/components/form-input/README.md
@@ -1,4 +1,4 @@
-# Textual and Value inputs
+# Form Input
 
 > Create various type inputs such as: `text`, `password`, `number`, `url`, `email`, `search`,
 > `range`, `date` and more.
diff --git a/src/components/form-radio/README.md b/src/components/form-radio/README.md
@@ -1,4 +1,4 @@
-# Form Radio Inputs
+# Form Radio
 
 > For cross browser consistency, `<b-form-radio-group>` and `<b-form-radio>` uses Bootstrap's custom
 > radio input to replace the browser default radio input. It is built on top of semantic and
diff --git a/src/components/form-textarea/README.md b/src/components/form-textarea/README.md
@@ -1,4 +1,4 @@
-# Form textarea
+# Form Textarea
 
 > Create multi-line text inputs with support for auto height sizing, minimum and maximum number of
 > rows, and contextual states.
diff --git a/src/components/form/README.md b/src/components/form/README.md
@@ -198,9 +198,9 @@ See also:
 - [`<b-form-timepicker>`](/docs/components/form-timepicker) Time picker custom form input
 - [`<b-form-rating>`](/docs/components/form-rating) Star rating custom form input and display
 - [`<b-button>`](/docs/components/button) Buttons
-- [`<b-form-group>`](/docs/components/form-group) Form input wrapper to generate form-groups that
+- [`<b-form-group>`](/docs/components/form-group) Form Input wrapper to generate form-groups that
   support labels, help text and feedback
-- [`<b-input-group>`](/docs/components/input-group) Form inputs with add-ons
+- [`<b-input-group>`](/docs/components/input-group) Form Inputs with add-ons
 - [`<b-form-row>`](/docs/components/layout) Create grid rows and columns with tighter margins
   (available via the [Layout and grid components](/docs/components/layout))
 
diff --git a/src/components/image/README.md b/src/components/image/README.md
@@ -1,4 +1,4 @@
-# Images
+# Image
 
 > Documentation and examples for opting images (via `<b-img>` component) into responsive behavior
 > (so they never become larger than their parent elements), optionally adding lightweight styles to
diff --git a/src/components/input-group/README.md b/src/components/input-group/README.md
@@ -1,4 +1,4 @@
-# Input Groups
+# Input Group
 
 > Easily extend form controls by adding text, buttons, or button groups on either side of textual
 > inputs.
diff --git a/src/components/link/README.md b/src/components/link/README.md
@@ -1,4 +1,4 @@
-# Links
+# Link
 
 > Use BootstrapVue's custom `b-link` component for generating a standard `<a>` link or
 > `<router-link>`. `<b-link>` supports the `disabled` state and `click` event propagation.
diff --git a/src/components/list-group/README.md b/src/components/list-group/README.md
@@ -1,6 +1,6 @@
-# List group
+# List Group
 
-> List groups are a flexible and powerful component for displaying a series of content. List group
+> List Groups are a flexible and powerful component for displaying a series of content. List Group
 > items can be modified to support just about any content within. They can also be used as
 > navigation via various props.
 
@@ -161,7 +161,7 @@ more with the help of some [flex utility classes](/docs/reference/utility-classe
 <!-- b-list-group-badges.vue -->
 ```
 
-## List groups inside cards
+## List Groups inside cards
 
 Incorporate list groups into [cards](/docs/components/card). Use the `<b-list-group>` prop `flush`
 prop when using cards with `no-body` to make the sides of the list group flush with the card.
@@ -247,7 +247,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
 <b-list-group>
   <b-list-group-item href="#" active class="flex-column align-items-start">
     <div class="d-flex w-100 justify-content-between">
-      <h5 class="mb-1">List group item heading</h5>
+      <h5 class="mb-1">List Group item heading</h5>
       <small>3 days ago</small>
     </div>
 
@@ -260,7 +260,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
 
   <b-list-group-item href="#" class="flex-column align-items-start">
     <div class="d-flex w-100 justify-content-between">
-      <h5 class="mb-1">List group item heading</h5>
+      <h5 class="mb-1">List Group item heading</h5>
       <small class="text-muted">3 days ago</small>
     </div>
 
@@ -273,7 +273,7 @@ help of [flexbox utility classes](/docs/reference/utility-classes).
 
   <b-list-group-item href="#" disabled class="flex-column align-items-start">
     <div class="d-flex w-100 justify-content-between">
-      <h5 class="mb-1">Disabled List group item</h5>
+      <h5 class="mb-1">Disabled List Group item</h5>
       <small class="text-muted">3 days ago</small>
     </div>
 
diff --git a/src/components/list-group/package.json b/src/components/list-group/package.json
@@ -2,8 +2,8 @@
   "name": "@bootstrap-vue/list-group",
   "version": "1.0.0",
   "meta": {
-    "title": "List group",
-    "description": "List groups are a flexible and powerful component for displaying a series of content. List group items can be modified to support just about any content within. They can also be used as navigation via various props.",
+    "title": "List Group",
+    "description": "List Groups are a flexible and powerful component for displaying a series of content. List Group items can be modified to support just about any content within. They can also be used as navigation via various props.",
     "components": [
       {
         "component": "BListGroup",
diff --git a/src/components/modal/README.md b/src/components/modal/README.md
@@ -1,4 +1,4 @@
-# Modals
+# Modal
 
 > Modals are streamlined, but flexible dialog prompts powered by JavaScript and CSS. They support a
 > number of use cases from user notification to completely custom content and feature a handful of
diff --git a/src/components/nav/README.md b/src/components/nav/README.md
@@ -1,4 +1,4 @@
-# Navs
+# Nav
 
 > Navigation available in Bootstrap share general markup and styles, from the base `<b-nav>` class
 > to the `active` and `disabled` states. Swap modifier props to switch between each style.
diff --git a/src/components/navbar/README.md b/src/components/navbar/README.md
@@ -241,7 +241,7 @@ Use `<b-nav-form>` to place inline form controls into your navbar
 <!-- b-navbar-form.vue -->
 ```
 
-Input groups work as well:
+Input Groups work as well:
 
 ```html
 <div>
diff --git a/src/components/pagination-nav/README.md b/src/components/pagination-nav/README.md
@@ -1,4 +1,4 @@
-# Pagination Navigation
+# Pagination Nav
 
 > Quick first, previous, next, last, and page buttons for navigation based pagination, supporting
 > regular links or router links.
diff --git a/src/components/spinner/README.md b/src/components/spinner/README.md
@@ -1,4 +1,4 @@
-# Spinners
+# Spinner
 
 > The `<b-spinner>` component can be used to show the loading state in your projects. They're
 > rendered only with basic HTML and CSS as a lightweight Vue functional component. Their appearance,
diff --git a/src/components/table/README.md b/src/components/table/README.md
@@ -1,4 +1,4 @@
-# Tables
+# Table
 
 > For displaying tabular data, `<b-table>` supports pagination, filtering, sorting, custom
 > rendering, various style options, events, and asynchronous data. For simple display of tabular
diff --git a/src/components/toast/README.md b/src/components/toast/README.md
@@ -1,4 +1,4 @@
-# Toasts
+# Toast
 
 > Push notifications to your visitors with a `<b-toast>` and `<b-toaster>`, lightweight components
 > which are easily customizable for generating alert messages.
diff --git a/src/components/toast/package.json b/src/components/toast/package.json
@@ -2,7 +2,7 @@
   "name": "@bootstrap-vue/toast",
   "version": "1.0.0",
   "meta": {
-    "title": "Toasts",
+    "title": "Toast",
     "slug": "toast",
     "description": "Push notifications to your visitors with a toast, a lightweight and easily customizable alert message.",
     "plugins": [
diff --git a/src/components/tooltip/README.md b/src/components/tooltip/README.md
@@ -1,4 +1,4 @@
-# Tooltips
+# Tooltip
 
 > Easily add tooltips to elements or components via the `<b-tooltip>` component or
 > [`v-b-tooltip`](/docs/directives/tooltip) directive (preferred method).
diff --git a/src/directives/popover/README.md b/src/directives/popover/README.md
@@ -1,4 +1,4 @@
-# Popovers
+# Popover
 
 > Documentation and examples for adding BootstrapVue popovers to any element on your site, using
 > Bootstrap v4 CSS for styling and animations. Popovers can be triggered by hovering, focusing, or
diff --git a/src/directives/scrollspy/README.md b/src/directives/scrollspy/README.md
@@ -1,4 +1,4 @@
-# ScrollSpy
+# Scrollspy
 
 > Automatically update Bootstrap navigation or list group components based on scroll position to
 > indicate which link is currently active in the viewport.
@@ -299,7 +299,7 @@ If any of the options are invalid types, then an error is written to the console
 
 - If scroll element is not present, then we assume scrolling on `<body>`
 - If scroll element is a CSS selector, the first found element is chosen
-- If scroll element is not found, then ScrollSpy silently does nothing
+- If scroll element is not found, then Scrollspy silently does nothing
 
 **Important! Requires relative positioning** No matter the implementation method, scrollspy requires
 the use of `position: relative;` on the element you're scrolling on. In most cases this is the
diff --git a/src/directives/scrollspy/helpers/bv-scrollspy.class.js b/src/directives/scrollspy/helpers/bv-scrollspy.class.js
@@ -1,5 +1,5 @@
 /*
- * ScrollSpy class definition
+ * Scrollspy class definition
  */
 
 import { EVENT_OPTIONS_NO_CAPTURE } from '../../../constants/events'
@@ -115,7 +115,7 @@ const typeCheckConfig = (
  */
 
 /* istanbul ignore next: not easy to test */
-export class BVScrollSpy /* istanbul ignore next: not easy to test */ {
+export class BVScrollspy /* istanbul ignore next: not easy to test */ {
   constructor(element, config, $root) {
     // The element we activate links in
     this.$el = element
diff --git a/src/directives/scrollspy/scrollspy.js b/src/directives/scrollspy/scrollspy.js
@@ -3,16 +3,16 @@ import { isNumber, isObject, isString } from '../../utils/inspect'
 import { mathRound } from '../../utils/math'
 import { toInteger } from '../../utils/number'
 import { keys } from '../../utils/object'
-import { BVScrollSpy } from './helpers/bv-scrollspy.class'
+import { BVScrollspy } from './helpers/bv-scrollspy.class'
 
 // Key we use to store our instance
-const BV_SCROLLSPY = '__BV_ScrollSpy__'
+const BV_SCROLLSPY = '__BV_Scrollspy__'
 
 // Pre-compiled regular expressions
 const onlyDigitsRE = /^\d+$/
 const offsetRE = /^(auto|position|offset)$/
 
-// Build a ScrollSpy config based on bindings (if any)
+// Build a Scrollspy config based on bindings (if any)
 // Arguments and modifiers take precedence over passed value config object
 /* istanbul ignore next: not easy to test */
 const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
@@ -47,7 +47,7 @@ const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
     // Value is config object
     // Filter the object based on our supported config options
     keys(bindings.value)
-      .filter(k => !!BVScrollSpy.DefaultType[k])
+      .filter(k => !!BVScrollspy.DefaultType[k])
       .forEach(k => {
         config[k] = bindings.value[k]
       })
@@ -56,7 +56,7 @@ const parseBindings = bindings => /* istanbul ignore next: not easy to test */ {
   return config
 }
 
-// Add or update ScrollSpy on our element
+// Add or update Scrollspy on our element
 const applyScrollspy = (el, bindings, vnode) => /* istanbul ignore next: not easy to test */ {
   if (!IS_BROWSER) {
     /* istanbul ignore next */
@@ -66,11 +66,11 @@ const applyScrollspy = (el, bindings, vnode) => /* istanbul ignore next: not eas
   if (el[BV_SCROLLSPY]) {
     el[BV_SCROLLSPY].updateConfig(config, vnode.context.$root)
   } else {
-    el[BV_SCROLLSPY] = new BVScrollSpy(el, config, vnode.context.$root)
+    el[BV_SCROLLSPY] = new BVScrollspy(el, config, vnode.context.$root)
   }
 }
 
-// Remove ScrollSpy on our element
+// Remove Scrollspy on our element
 /* istanbul ignore next: not easy to test */
 const removeScrollspy = el => /* istanbul ignore next: not easy to test */ {
   if (el[BV_SCROLLSPY]) {
diff --git a/src/directives/tooltip/README.md b/src/directives/tooltip/README.md
@@ -1,7 +1,7 @@
-# Tooltips
+# Tooltip
 
-> Documentation and examples for adding custom BootstrapVue tooltips, using Bootstrap v4 CSS for
-> styling and animations. Tooltips can be triggered by hovering, focusing, or clicking an element
+> Add custom BootstrapVue tooltips to any element. Tooltips can be triggered by hovering, focusing,
+> or clicking an element.
 
 ## Overview
 
diff --git a/src/icons/README.md b/src/icons/README.md
@@ -1,4 +1,4 @@
-# Bootstrap Icons
+# Icons
 
 > Bootstrap Icons are designed to work with Bootstrap components, from form controls to navigation.
 > Bootstrap Icons are SVGs, so they scale quickly and easily and can be styled with CSS. While they
@@ -661,7 +661,7 @@ font scaled by 125%).
 <!-- icons-buttons.vue -->
 ```
 
-### Button groups and toolbars
+### Button Groups and toolbars
 
 #### Button Group
 
@@ -734,7 +734,7 @@ font scaled by 125%).
 <!-- icons-button-toolbar.vue -->
 ```
 
-### Input groups
+### Input Groups
 
 ```html
 <template>
@@ -774,7 +774,7 @@ font scaled by 125%).
 <!-- icons-input-groups.vue -->
 ```
 
-### List groups
+### List Groups
 
 ```html
 <template>
diff --git a/src/icons/package.json b/src/icons/package.json
@@ -2,7 +2,7 @@
   "name": "@bootstrap-vue/icons",
   "version": "1.0.0",
   "meta": {
-    "title": "Bootstrap Icons",
+    "title": "Icons",
     "version": "2.2.0",
     "bootstrap-icons-version": "1.2.2",
     "slug": "",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Alerts`
	`1`	`+# Alert`
`2`	`2`
`3`	`3`	`> Provide contextual feedback messages for typical user actions with the handful of available and`
`4`	`4`	`> flexible alert messages.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Badges`
	`1`	`+# Badge`
`2`	`2`
`3`	`3`	`> Small and adaptive tag for adding context to just about any content.`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Button toolbar`
	`1`	`+# Button Toolbar`
`2`	`2`
`3`	`3`	`> Group a series of button-groups and/or input-groups together on a single line, with optional`
`4`	`4`	`> keyboard navigation`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Buttons`
	`1`	`+# Button`
`2`	`2`
`3`	`3`	> Use Bootstrap's custom `b-button` component for actions in forms, dialogs, and more. Includes
`4`	`4`	`> support for a handful of contextual variations, sizes, states, and more.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Cards`
	`1`	`+# Card`
`2`	`2`
`3`	`3`	`> A card is a flexible and extensible content container. It includes options for headers and`
`4`	`4`	`> footers, a wide variety of content, contextual background colors, and powerful display options.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Dropdowns`
	`1`	`+# Dropdown`
`2`	`2`
`3`	`3`	`> Dropdowns are toggleable, contextual overlays for displaying lists of links and actions in a`
`4`	`4`	`> dropdown menu format.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Responsive Embeds`
	`1`	`+# Embed`
`2`	`2`
`3`	`3`	`> Create responsive video or slideshow embeds based on the width of the parent by creating an`
`4`	`4`	`> intrinsic ratio that scales on any device.`