Skip to content

Commit e606c62

Browse files
Use latest Markdown changes to validate (#336)
* Use latest Markdown changes to validate * Update markdown.yml * Use markdown-link-check tool * Disabling line length and HTML usage rules --------- Co-authored-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent 2318fe6 commit e606c62

4 files changed

Lines changed: 11 additions & 8 deletions

File tree

.github/markdown-link-check.jsonc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
{
2+
"verbose": true,
3+
"quiet": false,
24
"httpHeaders": [
35
{
46
"urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],

.github/markdownlint.jsonc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{
22
"default": true,
3-
"MD013": {
4-
"line_length": 120
5-
},
3+
"MD013": false,
4+
"MD033": false,
65
"MD034": false,
76
"MD041": false,
87
"MD007": {

.github/workflows/markdown.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ jobs:
2828

2929
- name: Checkout vscode-cmsis-debugger
3030
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
31+
with:
32+
ref: ${{ github.head_ref }}
3133

3234
- name: Register Markdownlint Warning Matcher
3335
run: echo "::add-matcher::.github/markdownlint.json"
@@ -52,11 +54,12 @@ jobs:
5254
egress-policy: audit
5355

5456
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
57+
with:
58+
ref: ${{ github.head_ref }}
5559

5660
- name: Check Links
57-
uses: gaurav-nelson/github-action-markdown-link-check@3c3b66f1f7d0900e37b71eca45b63ea9eedfce31 # master
61+
uses: tcort/github-action-markdown-link-check@a800ad5f1c35bf61987946fd31c15726a1c9f2ba # v1.1.0
5862
with:
59-
use-quiet-mode: 'yes'
63+
use-quiet-mode: 'no'
6064
use-verbose-mode: 'yes'
61-
base-branch: ${{ github.base_ref }}
6265
config-file: '.github/markdown-link-check.jsonc'

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,6 @@ session.
155155

156156
The following table describes the actions available in the debug toolbar:
157157

158-
<!-- markdownlint-disable MD013 MD033 -->
159158
| Action | Description |
160159
|--------|-------------|
161160
| Continue/Pause (F5) | **Continue**: Resume normal program/script execution (up to the next breakpoint).<br>**Pause**: Inspect code executing at the current line and debug line-by-line. |
@@ -164,7 +163,7 @@ The following table describes the actions available in the debug toolbar:
164163
| Step Out (Shift + F11) | When inside a method or subroutine, return to the earlier execution context by completing remaining lines of the current method as though it were a single command. |
165164
| Restart (Shift + Ctrl/Cmd + F5) | Terminate the current program execution and start debugging again using the current run configuration. |
166165
| Stop (Shift + F5) | Terminate the current program execution. |
167-
<!-- markdownlint-enable MD013 MD033 -->
166+
168167
If your debugging sessions involve multiple targets (for example, a multi-core device), the debug toolbar shows the
169168
list of sessions and lets you switch between them.
170169

0 commit comments

Comments
 (0)