Skip to content

Commit 7166e95

Browse files
authored
Markdownlint fixes (#37255)
1 parent ec68f3d commit 7166e95

File tree

13 files changed

+30
-31
lines changed

13 files changed

+30
-31
lines changed

.github/CONTRIBUTING.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ the preferred channel for [bug reports](#bug-reports), [features requests](#feat
1818
and [submitting pull requests](#pull-requests), but please respect the following
1919
restrictions:
2020

21-
* Please **do not** use the issue tracker for personal support requests. Stack Overflow ([`bootstrap-5`](https://stackoverflow.com/questions/tagged/bootstrap-5) tag), [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions) or [IRC](/README.md#community) are better places to get help.
21+
- Please **do not** use the issue tracker for personal support requests. Stack Overflow ([`bootstrap-5`](https://stackoverflow.com/questions/tagged/bootstrap-5) tag), [our GitHub Discussions](https://github.com/twbs/bootstrap/discussions) or [IRC](/README.md#community) are better places to get help.
2222

23-
* Please **do not** derail or troll issues. Keep the discussion on topic and
23+
- Please **do not** derail or troll issues. Keep the discussion on topic and
2424
respect the opinions of others.
2525

26-
* Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
26+
- Please **do not** post comments consisting solely of "+1" or ":thumbsup:".
2727
Use [GitHub's "reactions" feature](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
2828
instead. We reserve the right to delete comments which violate this rule.
2929

30-
* Please **do not** open issues regarding the official themes offered on <https://themes.getbootstrap.com/>.
30+
- Please **do not** open issues regarding the official themes offered on <https://themes.getbootstrap.com/>.
3131
Instead, please email any questions or feedback regarding those themes to `themes AT getbootstrap DOT com`.
3232

3333

@@ -101,16 +101,16 @@ Sometimes bugs reported to us are actually caused by bugs in the browser(s) them
101101

102102
| Vendor(s) | Browser(s) | Rendering engine | Bug reporting website(s) | Notes |
103103
| ------------- | ---------------------------- | ---------------- | ------------------------------------------------------ | -------------------------------------------------------- |
104-
| Mozilla | Firefox | Gecko | https://bugzilla.mozilla.org/enter_bug.cgi | "Core" is normally the right product option to choose. |
105-
| Apple | Safari | WebKit | https://bugs.webkit.org/enter_bug.cgi?product=WebKit | In Apple's bug reporter, choose "Safari" as the product. |
106-
| Google, Opera | Chrome, Chromium, Opera v15+ | Blink | https://bugs.chromium.org/p/chromium/issues/list | Click the "New issue" button. |
107-
| Microsoft | Edge | Blink | https://developer.microsoft.com/en-us/microsoft-edge/ | Go to "Help > Send Feedback" from the browser |
104+
| Mozilla | Firefox | Gecko | <https://bugzilla.mozilla.org/enter_bug.cgi> | "Core" is normally the right product option to choose. |
105+
| Apple | Safari | WebKit | <https://bugs.webkit.org/enter_bug.cgi?product=WebKit> | In Apple's bug reporter, choose "Safari" as the product. |
106+
| Google, Opera | Chrome, Chromium, Opera v15+ | Blink | <https://bugs.chromium.org/p/chromium/issues/list> | Click the "New issue" button. |
107+
| Microsoft | Edge | Blink | <https://developer.microsoft.com/en-us/microsoft-edge/> | Go to "Help > Send Feedback" from the browser |
108108

109109

110110
## Feature requests
111111

112112
Feature requests are welcome. But take a moment to find out whether your idea
113-
fits with the scope and aims of the project. It's up to *you* to make a strong
113+
fits with the scope and aims of the project. It's up to _you_ to make a strong
114114
case to convince the project's developers of the merits of this feature. Please
115115
provide as much detail and context as possible.
116116

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
<!-- Please add direct links where your modifications can be seen in the documentation -->
3333

34-
- https://deploy-preview-{your_pr_number}--twbs-bootstrap.netlify.app/
34+
- <https://deploy-preview-{your_pr_number}--twbs-bootstrap.netlify.app/>
3535

3636
### Related issues
3737

CODE_OF_CONDUCT.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the overall
25+
- Focusing on what is best not just for us as individuals, but for the overall
2626
community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or advances of
30+
- The use of sexualized language or imagery, and sexual attention or advances of
3131
any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email address,
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
3535
without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities

site/content/docs/5.2/components/modal.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -858,8 +858,8 @@ const myModal = new bootstrap.Modal('#myModal', {
858858
| Method | Description |
859859
| --- | --- |
860860
| `dispose` | Destroys an element's modal. (Removes stored data on the DOM element) |
861-
| `getInstance` | *Static* method which allows you to get the modal instance associated with a DOM element. |
862-
| `getOrCreateInstance` | *Static* method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn't initialized. |
861+
| `getInstance` | _Static_ method which allows you to get the modal instance associated with a DOM element. |
862+
| `getOrCreateInstance` | _Static_ method which allows you to get the modal instance associated with a DOM element, or create a new one in case it wasn't initialized. |
863863
| `handleUpdate` | Manually readjust the modal's position if the height of a modal changes while it is open (i.e. in case a scrollbar appears). |
864864
| `hide` | Manually hides a modal. **Returns to the caller before the modal has actually been hidden** (i.e. before the `hidden.bs.modal` event occurs). |
865865
| `show` | Manually opens a modal. **Returns to the caller before the modal has actually been shown** (i.e. before the `shown.bs.modal` event occurs). Also, you can pass a DOM element as an argument that can be received in the modal events (as the `relatedTarget` property). (i.e. `const modalToggle = document.getElementById('toggleMyModal'); myModal.show(modalToggle)`. |

site/content/docs/5.2/components/offcanvas.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ toc: true
1111
Offcanvas is a sidebar component that can be toggled via JavaScript to appear from the left, right, top, or bottom edge of the viewport. Buttons or anchors are used as triggers that are attached to specific elements you toggle, and `data` attributes are used to invoke our JavaScript.
1212

1313
- Offcanvas shares some of the same JavaScript code as modals. Conceptually, they are quite similar, but they are separate plugins.
14-
- Similarly, some [source Sass](#sass) variables for offcanvas's styles and dimensions are inherited from the modal's variables.
14+
- Similarly, some [source Sass](#sass-variables) variables for offcanvas's styles and dimensions are inherited from the modal's variables.
1515
- When shown, offcanvas includes a default backdrop that can be clicked to hide the offcanvas.
1616
- Similar to modals, only one offcanvas can be shown at a time.
1717

site/content/docs/5.2/components/placeholders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ The size of `.placeholder`s are based on the typographic style of the parent ele
126126

127127
### Animation
128128

129-
Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being _actively_ loaded.
129+
Animate placeholders with `.placeholder-glow` or `.placeholder-wave` to better convey the perception of something being *actively* loaded.
130130

131131
{{< example >}}
132132
<p class="placeholder-glow">

site/content/docs/5.2/components/popovers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ const popover = new bootstrap.Popover(element, {
238238
| `dispose` | Hides and destroys an element's popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. |
239239
| `enable` | Gives an element's popover the ability to be shown. **Popovers are enabled by default.** |
240240
| `getInstance` | _Static_ method which allows you to get the popover instance associated with a DOM element. |
241-
| `getOrCreateInstance` | *Static* method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn't initialized. |
241+
| `getOrCreateInstance` | _Static_ method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn't initialized. |
242242
| `hide` | Hides an element's popover. **Returns to the caller before the popover has actually been hidden** (i.e. before the `hidden.bs.popover` event occurs). This is considered a "manual" triggering of the popover. |
243243
| `setContent` | Gives a way to change the popover's content after its initialization. |
244244
| `show` | Reveals an element's popover. **Returns to the caller before the popover has actually been shown** (i.e. before the `shown.bs.popover` event occurs). This is considered a "manual" triggering of the popover. Popovers whose title and content are both zero-length are never displayed. |

site/content/docs/5.2/components/spinners.md

-2
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,7 @@ Used for creating the CSS animations for our spinners. Included in `scss/_spinne
205205

206206

207207
[color]: {{< docsref "/utilities/colors" >}}
208-
[display]: {{< docsref "/utilities/display" >}}
209208
[flex]: {{< docsref "/utilities/flex" >}}
210209
[float]: {{< docsref "/utilities/float" >}}
211210
[margin]: {{< docsref "/utilities/spacing" >}}
212-
[sizing]: {{< docsref "/utilities/sizing" >}}
213211
[text]: {{< docsref "/utilities/text" >}}

site/content/docs/5.2/extend/approach.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This principle is our first-class JavaScript API using `data` attributes. You do
6565

6666
Lastly, our styles build on the fundamental behaviors of common web elements. Whenever possible, we prefer to use what the browser provides. For example, you can put a `.btn` class on nearly any element, but most elements don't provide any semantic value or browser functionality. So instead, we use `<button>`s and `<a>`s.
6767

68-
The same goes for more complex components. While we *could* write our own form validation plugin to add classes to a parent element based on an input's state, thereby allowing us to style the text say red, we prefer using the `:valid`/`:invalid` pseudo-elements every browser provides us.
68+
The same goes for more complex components. While we _could_ write our own form validation plugin to add classes to a parent element based on an input's state, thereby allowing us to style the text say red, we prefer using the `:valid`/`:invalid` pseudo-elements every browser provides us.
6969

7070
## Utilities
7171

site/content/docs/5.2/getting-started/vite.md

+1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ We're building a Vite project with Bootstrap from scratch, so there are some pre
3535
```sh
3636
npm i --save bootstrap @popperjs/core
3737
```
38+
3839
4. **Install additional dependency.** In addition to Vite and Bootstrap, we need another dependency (Sass) to properly import and bundle Bootstrap's CSS.
3940

4041
```sh

site/content/docs/5.2/layout/breakpoints.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ These Sass mixins translate in our compiled CSS using the values declared in our
9494

9595
### Max-width
9696

97-
We occasionally use media queries that go in the other direction (the given screen size *or smaller*):
97+
We occasionally use media queries that go in the other direction (the given screen size _or smaller_):
9898

9999
```scss
100100
// No media query necessary for xs breakpoint as it's effectively `@media (max-width: 0) { ... }`

site/content/docs/5.2/utilities/flex.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ Additionally there are also responsive `.order-first` and `.order-last` classes
462462

463463
## Align content
464464

465-
Use `align-content` utilities on flexbox containers to align flex items *together* on the cross axis. Choose from `start` (browser default), `end`, `center`, `between`, `around`, or `stretch`. To demonstrate these utilities, we've enforced `flex-wrap: wrap` and increased the number of flex items.
465+
Use `align-content` utilities on flexbox containers to align flex items _together_ on the cross axis. Choose from `start` (browser default), `end`, `center`, `between`, `around`, or `stretch`. To demonstrate these utilities, we've enforced `flex-wrap: wrap` and increased the number of flex items.
466466

467467
**Heads up!** This property has no effect on single rows of flex items.
468468

site/content/docs/5.2/utilities/interactions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The `.pe-none` class (and the `pointer-events` CSS property it sets) only preven
3131
If possible, the simpler solution is:
3232

3333
- For form controls, add the `disabled` HTML attribute.
34-
* For links, remove the `href` attribute, making it a non-interactive anchor or placeholder link.
34+
- For links, remove the `href` attribute, making it a non-interactive anchor or placeholder link.
3535

3636
## Sass
3737

0 commit comments

Comments
 (0)