Skip to content

Commit 51624f6

Browse files
adamalstonadamalston
authored
docs: format MD and MDX docs (#22000)
* docs: format MD and MDX docs * fix: prevent mdx paragraph wrapping in jsx children * docs: remove ComboBox shouldFilterItem example
1 parent bb0a95b commit 51624f6

152 files changed

Lines changed: 752 additions & 615 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.editorconfig‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
# EditorConfig helps developers define and maintain consistent # top-most EditorConfig file
2-
# coding styles between different editors and IDEs
3-
# editorconfig.org
41
root = true
52

63
[*]
@@ -9,8 +6,4 @@ end_of_line = lf
96
indent_size = 2
107
indent_style = space
118
insert_final_newline = true
12-
max_line_length = 80
139
trim_trailing_whitespace = true
14-
15-
[*.md]
16-
trim_trailing_whitespace = false

‎.github/ISSUE_TEMPLATE/ACCESSIBILITY_ISSUE.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,5 @@ body:
159159
attributes:
160160
value: |
161161
> [!TIP]
162+
>
162163
> You do not need to apply labels. Labels are applied automatically and by the Carbon team when your issue is triaged.

‎.github/ISSUE_TEMPLATE/BUG_REPORT.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,5 @@ body:
129129
attributes:
130130
value: |
131131
> [!TIP]
132+
>
132133
> You do not need to apply labels. Labels are applied automatically and by the Carbon team when your issue is triaged.

‎.github/ISSUE_TEMPLATE/DESIGN_DEFECT.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,5 @@ body:
9999
attributes:
100100
value: |
101101
> [!TIP]
102+
>
102103
> You do not need to apply labels. Labels are applied automatically and by the Carbon team when your issue is triaged.

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,4 +142,5 @@ body:
142142
attributes:
143143
value: |
144144
> [!TIP]
145+
>
145146
> You do not need to apply labels. Labels are applied automatically and by the Carbon team when your issue is triaged.

‎.github/ISSUE_TEMPLATE/QUESTION.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,5 @@ body:
5757
attributes:
5858
value: |
5959
> [!TIP]
60+
>
6061
> You do not need to apply labels. Labels are applied automatically and by the Carbon team when your issue is triaged.

‎docs/guides/reviewing-pull-requests.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
- **Contributors**: use this as a guide for what to include in your PRs so
55
they'll sail through review ⛵
66

7-
> [!IMPORTANT] This just serves as a starting point. It will not include every
8-
> small nit and detail that might end up in a PR review.
7+
> [!IMPORTANT]
8+
>
9+
> This just serves as a starting point. It will not include every small nit and
10+
> detail that might end up in a PR review.
911
>
1012
> This document should remain as small as possible! The longer this gets, the
1113
> more difficult it will be to read and absorb.

‎docs/guides/sass.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@
2323
The `@carbon/styles` package ships all of the styles for the Carbon Design
2424
System.
2525

26-
> [!IMPORTANT]
26+
> [!IMPORTANT]
27+
>
2728
> You probably don't need to install this package. Framework variant packages
2829
> such as `@carbon/react` re-export all of `@carbon/styles`. For the examples
2930
> below `@carbon/styles` paths can be switched out for `@carbon/react` without
@@ -120,7 +121,8 @@ To use only a specific module, include the full path.
120121
@use '@carbon/styles/scss/<path-to-file>';
121122
```
122123

123-
> [!NOTE]
124+
> [!NOTE]
125+
>
124126
> Sass modules can only ever be configured once. Bringing in this module and
125127
> configuring it should be one of the first things you do in your project.
126128
>

‎docs/preview-code.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ Over time it becomes apparent a preview API has stabilized and suits the needs
8383
of most users. If it isn't a breaking change, and there hasn't been much
8484
movement, it can be moved from "preview" status to be "stable".
8585

86-
> [!IMPORTANT]
86+
> [!IMPORTANT]
87+
>
8788
> To initiate a move to stable:
8889
>
8990
> 1. [Open a new issue](https://github.com/carbon-design-system/carbon/issues/new?template=Blank+issue)

‎package.json‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
"ci-check": "carbon-cli ci-check",
1919
"clean": "lerna run clean && lerna clean --yes && rimraf node_modules",
2020
"doctoc": "doctoc --title '## Table of Contents'",
21-
"format": "prettier --cache --write '**/*.{js,md,scss,ts,tsx}' '!**/{build,es,lib,storybook,ts,umd}/**'",
22-
"format:diff": "prettier --list-different '**/*.{js,md,scss,ts,tsx}' '!**/{build,es,lib,storybook,ts,umd}/**' '!packages/components/**'",
21+
"format": "prettier --cache --write '**/*.{js,md,mdx,scss,ts,tsx}' '!**/{build,es,lib,storybook,ts,umd}/**'",
22+
"format:diff": "prettier --list-different '**/*.{js,md,mdx,scss,ts,tsx}' '!**/{build,es,lib,storybook,ts,umd}/**' '!packages/components/**'",
2323
"lint": "eslint actions config packages www",
2424
"lint:fix": "eslint --cache --fix --max-warnings 0 actions config packages www",
2525
"lint:styles": "stylelint '**/*.scss' --report-needless-disables --report-invalid-scope-disables",
@@ -141,6 +141,9 @@
141141
"!(*sass).md": [
142142
"prettier --cache --write"
143143
],
144+
"!(*sass).mdx": [
145+
"prettier --cache --write"
146+
],
144147
"{README.md,.all-contributorsrc}": [
145148
"all-contributors generate"
146149
]

0 commit comments

Comments
 (0)