|
9 | 9 | [io-doc]: https://cpp-linter.github.io/cpp-linter-action/inputs-outputs |
10 | 10 | [recipes-doc]: https://cpp-linter.github.io/cpp-linter-action/examples |
11 | 11 |
|
12 | | -[format-annotations-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/annotations-clang-format.png |
13 | | -[tidy-annotations-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/annotations-clang-tidy.png |
14 | | -[thread-comment-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/comment.png |
15 | | -[step-summary-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/step-summary.png |
16 | | -[tidy-review-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/tidy-review.png |
17 | | -[format-review-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/format-review.png |
18 | | -[format-suggestion-preview]: https://raw.githubusercontent.com/cpp-linter/cpp-linter-action/main/docs/images/format-suggestion.png |
19 | | - |
20 | | -<!--README-start--> |
| 12 | +<!-- start --> |
21 | 13 |
|
22 | 14 | # C/C++ Linter Action <sub><sup>| clang-format & clang-tidy</sup></sub> |
23 | 15 |
|
@@ -95,48 +87,78 @@ See also our [example recipes][recipes-doc]. |
95 | 87 | <strong> and <a href="https://github.com/cpp-linter/cpp-linter-action/network/dependents">many more</a>.</strong> |
96 | 88 | </p> |
97 | 89 |
|
| 90 | +<!-- stop --> |
98 | 91 | ## Example |
99 | 92 |
|
100 | 93 | ### Annotations |
101 | 94 |
|
102 | | -Using [`file-annotations`][file-annotations]: |
| 95 | +Using [`--file-annotations`][file-annotations]: |
103 | 96 |
|
104 | 97 | #### clang-format annotations |
105 | 98 |
|
106 | | -![clang-format annotations][format-annotations-preview] |
| 99 | +<picture> |
| 100 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/format-annotation-dark.png"> |
| 101 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/format-annotation-light.png"> |
| 102 | + <img alt="format-annotation-preview." src="docs/images/format-annotation-light.png"> |
| 103 | +</picture> |
107 | 104 |
|
108 | 105 | #### clang-tidy annotations |
109 | 106 |
|
110 | | -![clang-tidy annotations][tidy-annotations-preview] |
| 107 | +<picture> |
| 108 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/tidy-annotation-dark.png"> |
| 109 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/tidy-annotation-light.png"> |
| 110 | + <img alt="tidy-annotation-preview." src="docs/images/tidy-annotation-light.png"> |
| 111 | +</picture> |
111 | 112 |
|
112 | 113 | ### Thread Comment |
113 | 114 |
|
114 | | -Using [`thread-comments`][thread-comments]: |
| 115 | +Using [`--thread-comments`][thread-comments]: |
115 | 116 |
|
116 | | -![sample thread-comment][thread-comment-preview] |
| 117 | +<picture> |
| 118 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/thread-comment-dark.png"> |
| 119 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/thread-comment-light.png"> |
| 120 | + <img alt="thread-comment-preview." src="docs/images/thread-comment-light.png"> |
| 121 | +</picture> |
117 | 122 |
|
118 | 123 | ### Step Summary |
119 | 124 |
|
120 | | -Using [`step-summary`][step-summary]: |
| 125 | +Using [`--step-summary`][step-summary]: |
121 | 126 |
|
122 | | -![step summary][step-summary-preview] |
| 127 | +<picture> |
| 128 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/step-summary-dark.png"> |
| 129 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/step-summary-light.png"> |
| 130 | + <img alt="step-summary-preview." src="docs/images/step-summary-light.png"> |
| 131 | +</picture> |
123 | 132 |
|
124 | 133 | ### Pull Request Review |
125 | 134 |
|
126 | | -#### Only clang-tidy |
| 135 | +<picture> |
| 136 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/review-summary-dark.png"> |
| 137 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/review-summary-light.png"> |
| 138 | + <img alt="review-summary-preview." src="docs/images/review-summary-light.png"> |
| 139 | +</picture> |
127 | 140 |
|
128 | | -Using [`tidy-review`][tidy-review]: |
| 141 | +#### clang-tidy suggestion |
129 | 142 |
|
130 | | -![sample tidy-review][tidy-review-preview] |
| 143 | +Using [`--tidy-review`][tidy-review]: |
131 | 144 |
|
132 | | -#### Only clang-format |
| 145 | +<picture> |
| 146 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/tidy-review-dark.png"> |
| 147 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/tidy-review-light.png"> |
| 148 | + <img alt="tidy-review-preview." src="docs/images/tidy-review-light.png"> |
| 149 | +</picture> |
133 | 150 |
|
134 | | -Using [`format-review`][format-review]: |
| 151 | +#### clang-format suggestion |
135 | 152 |
|
136 | | -![sample format-review][format-review-preview] |
| 153 | +Using [`--format-review`][format-review]: |
137 | 154 |
|
138 | | -![sample format-suggestion][format-suggestion-preview] |
| 155 | +<picture> |
| 156 | + <source media="(prefers-color-scheme: dark)" srcset="docs/images/format-review-dark.png"> |
| 157 | + <source media="(prefers-color-scheme: light)" srcset="docs/images/format-review-light.png"> |
| 158 | + <img alt="format-review-preview." src="docs/images/format-review-light.png"> |
| 159 | +</picture> |
139 | 160 |
|
| 161 | +<!-- resume --> |
140 | 162 | ## Add C/C++ Linter Action badge in README |
141 | 163 |
|
142 | 164 | You can show C/C++ Linter Action status with a badge in your repository README |
|
0 commit comments