Skip to content

Commit

Permalink
Update cspell config (#35647)
Browse files Browse the repository at this point in the history
* specify the files to scan in the config
* enable `useGitignore` option
* remove a few unneeded suppressions
  • Loading branch information
XhmikosR authored Jan 11, 2022
1 parent 1726041 commit d581737
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 16 deletions.
18 changes: 7 additions & 11 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"callouts",
"clearfix",
"Codesniffer",
"colorspace",
"combinator",
"Contentful",
"Cpath",
Expand All @@ -43,9 +42,7 @@
"fieldsets",
"flexbox",
"fullscreen",
"fusv",
"getbootstrap",
"globby",
"Grayscale",
"Hoverable",
"hreflang",
Expand Down Expand Up @@ -86,20 +83,17 @@
"scrollbars",
"scrollspy",
"Segoe",
"sirv",
"srcset",
"stickied",
"Stylelint",
"subnav",
"svgo",
"tabbable",
"textareas",
"toggleable",
"topbar",
"touchend",
"twbs",
"unitless",
"Unported",
"unstylable",
"unstyled",
"Uppercased",
Expand All @@ -109,15 +103,17 @@
"vstack",
"walkthroughs",
"WCAG",
"webfont",
"Woohoo",
"zindex",
"بالعالم",
"مرحبًا"
],
"language": "en,en-US",
"language": "en, en-US",
"files": [
"site/**/*.md"
],
"ignorePaths": [
".cspell.json",
".min."
]
"*.min.*"
],
"useGitignore": true
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"docs-build": "hugo --cleanDestinationDir",
"docs-compile": "npm run docs-build",
"docs-linkinator": "linkinator _site --recurse --skip \"^(?!http://localhost)\" --verbosity error",
"docs-spellcheck": "cspell \"site/**/*.md\" --no-progress",
"docs-spellcheck": "cspell --no-progress",
"docs-vnu": "node build/vnu-jar.js",
"docs-lint": "npm-run-all --aggregate-output --parallel docs-vnu docs-linkinator docs-spellcheck",
"docs-serve": "hugo server --port 9001 --disableFastRender",
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.1/components/modal.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Toggle a working modal demo by clicking the button below. It will slide down and
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>Woohoo, you're reading this text in a modal!</p>
<p>Woo-hoo, you're reading this text in a modal!</p>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.1/customize/sass.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ In practice, you'd call the function and pass in the color and weight parameters

In order to meet [WCAG 2.0 accessibility standards for color contrast](https://www.w3.org/TR/UNDERSTANDING-WCAG20/visual-audio-contrast-contrast.html), authors **must** provide [a contrast ratio of at least 4.5:1](https://www.w3.org/WAI/WCAG20/quickref/20160105/Overview.php#visual-audio-contrast-contrast), with very few exceptions.

An additional function we include in Bootstrap is the color contrast function, `color-contrast`. It utilizes the [WCAG 2.0 algorithm](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests) for calculating contrast thresholds based on [relative luminance](https://www.w3.org/WAI/GL/wiki/Relative_luminance) in a `sRGB` colorspace to automatically return a light (`#fff`), dark (`#212529`) or black (`#000`) contrast color based on the specified base color. This function is especially useful for mixins or loops where you're generating multiple classes.
An additional function we include in Bootstrap is the color contrast function, `color-contrast`. It utilizes the [WCAG 2.0 algorithm](https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests) for calculating contrast thresholds based on [relative luminance](https://www.w3.org/WAI/GL/wiki/Relative_luminance) in a `sRGB` color space to automatically return a light (`#fff`), dark (`#212529`) or black (`#000`) contrast color based on the specified base color. This function is especially useful for mixins or loops where you're generating multiple classes.

For example, to generate color swatches from our `$theme-colors` map:

Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.1/getting-started/rtl.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ dt {

In the case you're using a custom font, be aware that not all fonts support the non-Latin alphabet. To switch from Pan-European to Arabic family, you may need to use `/*rtl:insert: {value}*/` in your font stack to modify the names of font families.

For example, to switch from `Helvetica Neue Webfont` for LTR to `Helvetica Neue Arabic` for RTL, your Sass code look like this:
For example, to switch from `Helvetica Neue` font for LTR to `Helvetica Neue Arabic` for RTL, your Sass code could look like this:

```scss
$font-family-sans-serif:
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/5.1/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Your custom Bootstrap CSS builds should now look something like this with a sepa

- We've ditched the default Sass map merges to make it easier to remove redundant values. Keep in mind you now have to define all values in the Sass maps like `$theme-colors`. Check out how to deal with [Sass maps]({{< docsref "/customize/sass#maps-and-loops" >}}).

- <span class="badge bg-danger">Breaking</span> Renamed `color-yiq()` function and related variables to `color-contrast()` as it's no longer related to YIQ colorspace. [See #30168.](https://github.com/twbs/bootstrap/pull/30168/)
- <span class="badge bg-danger">Breaking</span> Renamed `color-yiq()` function and related variables to `color-contrast()` as it's no longer related to YIQ color space. [See #30168.](https://github.com/twbs/bootstrap/pull/30168/)
- `$yiq-contrasted-threshold` is renamed to `$min-contrast-ratio`.
- `$yiq-text-dark` and `$yiq-text-light` are respectively renamed to `$color-contrast-dark` and `$color-contrast-light`.

Expand Down

0 comments on commit d581737

Please sign in to comment.