diff options
author | Mark Otto <markdotto@gmail.com> | 2020-05-14 08:33:49 +0300 |
---|---|---|
committer | XhmikosR <xhmikosr@gmail.com> | 2020-05-18 16:28:22 +0300 |
commit | d2f07ec9e1672651d01cf6471f19450d49613c76 (patch) | |
tree | a8b3249289837a5e490d4c737a2bbdad32b8a25b | |
parent | 897d2f3877ebde814a01a83bcc2633d99069a610 (diff) |
Fix some easy Markdown linting issues
- Always use dashes for bullets
- Add some basic alt text for our readme OC sponsors
-rw-r--r-- | CODE_OF_CONDUCT.md | 20 | ||||
-rw-r--r-- | README.md | 20 | ||||
-rw-r--r-- | js/tests/README.md | 12 | ||||
-rw-r--r-- | site/content/docs/5.0/about/license.md | 2 | ||||
-rw-r--r-- | site/content/docs/5.0/content/typography.md | 16 | ||||
-rw-r--r-- | site/content/docs/5.0/utilities/display.md | 22 | ||||
-rw-r--r-- | 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 9d9922f25f..963db62fe3 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 @@ -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 41fddb9a31..1e2b5d8688 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/<plugin-name>.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 a18fe0f601..07e60e00aa 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 7d4875e925..0bbe54c427 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: -* `<mark>` represents text which is marked or highlighted for reference or notation purposes. -* `<small>` represents side-comments and small print, like copyright and legal text. -* `<s>` represents element that are no longer relevant or no longer accurate. -* `<u>` represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. +- `<mark>` represents text which is marked or highlighted for reference or notation purposes. +- `<small>` represents side-comments and small print, like copyright and legal text. +- `<s>` represents element that are no longer relevant or no longer accurate. +- `<u>` 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 `<mark>`. -* `.small` will apply the same styles as `<small>`. -* `.text-decoration-underline` will apply the same styles as `<u>`. -* `.text-decoration-line-through` will apply the same styles as `<s>`. +- `.mark` will apply the same styles as `<mark>`. +- `.small` will apply the same styles as `<small>`. +- `.text-decoration-underline` will apply the same styles as `<u>`. +- `.text-decoration-line-through` will apply the same styles as `<s>`. While not shown above, feel free to use `<b>` and `<i>` in HTML5. `<b>` is meant to highlight words or phrases without conveying additional importance, while `<i>` 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 b80266af03..cbf41d2b39 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 ce32ad499f..e7a2960877 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.) |