From caeeaab348c9fbbbd7acd4617ceb2b331779cb0a Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Wed, 13 May 2020 22:33:49 -0700 Subject: [PATCH 1/2] Fix some easy Markdown linting issues - Always use dashes for bullets - Add some basic alt text for our readme OC sponsors --- CODE_OF_CONDUCT.md | 20 ++++++------- README.md | 20 ++++++------- js/tests/README.md | 12 ++++---- site/content/docs/5.0/about/license.md | 2 +- site/content/docs/5.0/content/typography.md | 16 +++++------ site/content/docs/5.0/utilities/display.md | 22 +++++++------- site/content/docs/5.0/utilities/spacing.md | 32 ++++++++++----------- 7 files changed, 62 insertions(+), 62 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9d9922f25f4d..963db62fe3fb 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/README.md b/README.md index 7ef4ca9aabb2..3420f440f28f 100644 --- a/README.md +++ b/README.md @@ -193,16 +193,16 @@ Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infras Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/bootstrap#sponsor)] -[![](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) -[![](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) -[![](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) -[![](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) -[![](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) -[![](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) -[![](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) -[![](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) -[![](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) -[![](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) +[![OC sponsor](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) ## Backers diff --git a/js/tests/README.md b/js/tests/README.md index 41fddb9a3118..1e2b5d868887 100644 --- a/js/tests/README.md +++ b/js/tests/README.md @@ -2,7 +2,7 @@ Bootstrap uses [Jasmine](https://jasmine.github.io/). Each plugin has a file dedicated to its tests in `tests/unit/.spec.js`. -* `visual/` contains "visual" tests which are run interactively in real browsers and require manual verification by humans. +- `visual/` contains "visual" tests which are run interactively in real browsers and require manual verification by humans. To run the unit test suite via [Karma](https://karma-runner.github.io/), run `npm run js-test`. To run the unit test suite via [Karma](https://karma-runner.github.io/) and debug, run `npm run js-debug`. @@ -18,11 +18,11 @@ To run the unit test suite via [Karma](https://karma-runner.github.io/) and debu ## What should a unit test look like? -* Each test should have a unique name clearly stating what unit is being tested. -* Each test should be in the corresponding `describe`. -* Each test should test only one unit per test, although one test can include several assertions. Create multiple tests for multiple units of functionality. -* Each test should use [`expect`](https://jasmine.github.io/api/edge/matchers.html) to ensure something is expected. -* Each test should follow the project's [JavaScript Code Guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#js) +- Each test should have a unique name clearly stating what unit is being tested. +- Each test should be in the corresponding `describe`. +- Each test should test only one unit per test, although one test can include several assertions. Create multiple tests for multiple units of functionality. +- Each test should use [`expect`](https://jasmine.github.io/api/edge/matchers.html) to ensure something is expected. +- Each test should follow the project's [JavaScript Code Guidelines](https://github.com/twbs/bootstrap/blob/master/CONTRIBUTING.md#js) ## Code coverage diff --git a/site/content/docs/5.0/about/license.md b/site/content/docs/5.0/about/license.md index a18fe0f601f2..07e60e00aab4 100644 --- a/site/content/docs/5.0/about/license.md +++ b/site/content/docs/5.0/about/license.md @@ -9,7 +9,7 @@ Bootstrap is released under the MIT license and is copyright {{< year >}} Twitte ## It requires you to: -* Keep the license and copyright notice included in Bootstrap's CSS and JavaScript files when you use them in your works +- Keep the license and copyright notice included in Bootstrap's CSS and JavaScript files when you use them in your works ## It permits you to: diff --git a/site/content/docs/5.0/content/typography.md b/site/content/docs/5.0/content/typography.md index 7d4875e9259e..0bbe54c427b0 100644 --- a/site/content/docs/5.0/content/typography.md +++ b/site/content/docs/5.0/content/typography.md @@ -153,17 +153,17 @@ Styling for common inline HTML5 elements. Beware that those tags should be used for semantic purpose: -* `` represents text which is marked or highlighted for reference or notation purposes. -* `` represents side-comments and small print, like copyright and legal text. -* `` represents element that are no longer relevant or no longer accurate. -* `` represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. +- `` represents text which is marked or highlighted for reference or notation purposes. +- `` represents side-comments and small print, like copyright and legal text. +- `` represents element that are no longer relevant or no longer accurate. +- `` represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. If you want to style your text, you should use the following classes instead: -* `.mark` will apply the same styles as ``. -* `.small` will apply the same styles as ``. -* `.text-decoration-underline` will apply the same styles as ``. -* `.text-decoration-line-through` will apply the same styles as ``. +- `.mark` will apply the same styles as ``. +- `.small` will apply the same styles as ``. +- `.text-decoration-underline` will apply the same styles as ``. +- `.text-decoration-line-through` will apply the same styles as ``. While not shown above, feel free to use `` and `` in HTML5. `` is meant to highlight words or phrases without conveying additional importance, while `` is mostly for voice, technical terms, etc. diff --git a/site/content/docs/5.0/utilities/display.md b/site/content/docs/5.0/utilities/display.md index b80266af03bd..cbf41d2b3959 100644 --- a/site/content/docs/5.0/utilities/display.md +++ b/site/content/docs/5.0/utilities/display.md @@ -16,20 +16,20 @@ Display utility classes that apply to all [breakpoints]({{< docsref "/layout/bre As such, the classes are named using the format: -* `.d-{value}` for `xs` -* `.d-{breakpoint}-{value}` for `sm`, `md`, `lg`, `xl`, and `xxl`. +- `.d-{value}` for `xs` +- `.d-{breakpoint}-{value}` for `sm`, `md`, `lg`, `xl`, and `xxl`. Where *value* is one of: -* `none` -* `inline` -* `inline-block` -* `block` -* `table` -* `table-cell` -* `table-row` -* `flex` -* `inline-flex` +- `none` +- `inline` +- `inline-block` +- `block` +- `table` +- `table-cell` +- `table-row` +- `flex` +- `inline-flex` The display values can be altered by changing the `$displays` variable and recompiling the SCSS. diff --git a/site/content/docs/5.0/utilities/spacing.md b/site/content/docs/5.0/utilities/spacing.md index ce32ad499f7b..e7a2960877c4 100644 --- a/site/content/docs/5.0/utilities/spacing.md +++ b/site/content/docs/5.0/utilities/spacing.md @@ -18,28 +18,28 @@ The classes are named using the format `{property}{sides}-{size}` for `xs` and ` Where *property* is one of: -* `m` - for classes that set `margin` -* `p` - for classes that set `padding` +- `m` - for classes that set `margin` +- `p` - for classes that set `padding` Where *sides* is one of: -* `t` - for classes that set `margin-top` or `padding-top` -* `b` - for classes that set `margin-bottom` or `padding-bottom` -* `l` - for classes that set `margin-left` or `padding-left` -* `r` - for classes that set `margin-right` or `padding-right` -* `x` - for classes that set both `*-left` and `*-right` -* `y` - for classes that set both `*-top` and `*-bottom` -* blank - for classes that set a `margin` or `padding` on all 4 sides of the element +- `t` - for classes that set `margin-top` or `padding-top` +- `b` - for classes that set `margin-bottom` or `padding-bottom` +- `l` - for classes that set `margin-left` or `padding-left` +- `r` - for classes that set `margin-right` or `padding-right` +- `x` - for classes that set both `*-left` and `*-right` +- `y` - for classes that set both `*-top` and `*-bottom` +- blank - for classes that set a `margin` or `padding` on all 4 sides of the element Where *size* is one of: -* `0` - for classes that eliminate the `margin` or `padding` by setting it to `0` -* `1` - (by default) for classes that set the `margin` or `padding` to `$spacer * .25` -* `2` - (by default) for classes that set the `margin` or `padding` to `$spacer * .5` -* `3` - (by default) for classes that set the `margin` or `padding` to `$spacer` -* `4` - (by default) for classes that set the `margin` or `padding` to `$spacer * 1.5` -* `5` - (by default) for classes that set the `margin` or `padding` to `$spacer * 3` -* `auto` - for classes that set the `margin` to auto +- `0` - for classes that eliminate the `margin` or `padding` by setting it to `0` +- `1` - (by default) for classes that set the `margin` or `padding` to `$spacer * .25` +- `2` - (by default) for classes that set the `margin` or `padding` to `$spacer * .5` +- `3` - (by default) for classes that set the `margin` or `padding` to `$spacer` +- `4` - (by default) for classes that set the `margin` or `padding` to `$spacer * 1.5` +- `5` - (by default) for classes that set the `margin` or `padding` to `$spacer * 3` +- `auto` - for classes that set the `margin` to auto (You can add more sizes by adding entries to the `$spacers` Sass map variable.) From 849e01899fc402953792bd3db7589c702273265a Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Thu, 14 May 2020 09:01:40 +0300 Subject: [PATCH 2/2] More Markdownlint fixes --- README.md | 20 ++++++++++---------- site/content/docs/5.0/content/tables.md | 2 +- site/content/docs/5.0/customize/optimize.md | 4 ++-- site/content/docs/5.0/migration.md | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3420f440f28f..7d8081a2dd24 100644 --- a/README.md +++ b/README.md @@ -193,16 +193,16 @@ Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infras Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/bootstrap#sponsor)] -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) -[![OC sponsor](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) +[![OC sponsor 0](https://opencollective.com/bootstrap/sponsor/0/avatar.svg)](https://opencollective.com/bootstrap/sponsor/0/website) +[![OC sponsor 1](https://opencollective.com/bootstrap/sponsor/1/avatar.svg)](https://opencollective.com/bootstrap/sponsor/1/website) +[![OC sponsor 2](https://opencollective.com/bootstrap/sponsor/2/avatar.svg)](https://opencollective.com/bootstrap/sponsor/2/website) +[![OC sponsor 3](https://opencollective.com/bootstrap/sponsor/3/avatar.svg)](https://opencollective.com/bootstrap/sponsor/3/website) +[![OC sponsor 4](https://opencollective.com/bootstrap/sponsor/4/avatar.svg)](https://opencollective.com/bootstrap/sponsor/4/website) +[![OC sponsor 5](https://opencollective.com/bootstrap/sponsor/5/avatar.svg)](https://opencollective.com/bootstrap/sponsor/5/website) +[![OC sponsor 6](https://opencollective.com/bootstrap/sponsor/6/avatar.svg)](https://opencollective.com/bootstrap/sponsor/6/website) +[![OC sponsor 7](https://opencollective.com/bootstrap/sponsor/7/avatar.svg)](https://opencollective.com/bootstrap/sponsor/7/website) +[![OC sponsor 8](https://opencollective.com/bootstrap/sponsor/8/avatar.svg)](https://opencollective.com/bootstrap/sponsor/8/website) +[![OC sponsor 9](https://opencollective.com/bootstrap/sponsor/9/avatar.svg)](https://opencollective.com/bootstrap/sponsor/9/website) ## Backers diff --git a/site/content/docs/5.0/content/tables.md b/site/content/docs/5.0/content/tables.md index 1d5477313aa0..156a68e90d13 100644 --- a/site/content/docs/5.0/content/tables.md +++ b/site/content/docs/5.0/content/tables.md @@ -399,7 +399,7 @@ Border styles, active styles, and table variants are not inherited by nested tab ## How nesting works -To prevent _any_ styles from leaking to nested tables, we use the child combinator (`>`) selector in our CSS. Since we need to target all the `td`s and `th`s in the `thead`, `tbody`, and `tfoot`, our selector would look pretty long without it. As such, we use the rather odd looking `.table > :not(caption) > * > * ` selector to target all `td`s and `th`s of the `.table`, but none of any potential nested tables. +To prevent _any_ styles from leaking to nested tables, we use the child combinator (`>`) selector in our CSS. Since we need to target all the `td`s and `th`s in the `thead`, `tbody`, and `tfoot`, our selector would look pretty long without it. As such, we use the rather odd looking `.table > :not(caption) > * > *` selector to target all `td`s and `th`s of the `.table`, but none of any potential nested tables. Note that if you add ``s as direct children of a table, those `` will be wrapped in a `` by default, thus making our selectors work as intended. diff --git a/site/content/docs/5.0/customize/optimize.md b/site/content/docs/5.0/customize/optimize.md index d5e3906e3664..a6a306109f49 100644 --- a/site/content/docs/5.0/customize/optimize.md +++ b/site/content/docs/5.0/customize/optimize.md @@ -43,8 +43,8 @@ _Help wanted with this section, please consider opening a PR. Thanks!_ While we don't have a prebuilt example for using [PurgeCSS](https://github.com/FullHuman/purgecss) with Bootstrap, there are some helpful articles and walkthroughs that the community has written. Here are some options: -- https://medium.com/dwarves-foundation/remove-unused-css-styles-from-bootstrap-using-purgecss-88395a2c5772 -- https://lukencode.com/2018/07/29/automatically-removeunused-css-from-bootstrap-or-other-frameworks/ +- +- Lastly, this [CSS Tricks article on unused CSS](https://css-tricks.com/how-do-you-remove-unused-css-from-a-site/) shows how to use PurgeCSS and other similar tools. diff --git a/site/content/docs/5.0/migration.md b/site/content/docs/5.0/migration.md index 96059e31e215..998dd9974e73 100644 --- a/site/content/docs/5.0/migration.md +++ b/site/content/docs/5.0/migration.md @@ -187,6 +187,6 @@ Badges were overhauled to better differentiate themselves from buttons and to be ## Docs -- Removed "Wall of browser bugs" page because it has become obsolete +- Removed "Wall of browser bugs" page because it has become obsolete ## Build tools