Skip to content

Commit

Permalink
Auto-fix linting and remove line length linting (#1020)
Browse files Browse the repository at this point in the history
* auto-fix markdownlint issues on save

* Add to README

* remove line size from markdown linting
  • Loading branch information
SeanKilleen authored Feb 10, 2025
1 parent f7c2ca6 commit 4325c7d
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
5 changes: 1 addition & 4 deletions .github/linters/.markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@
# Rules by id #
###############
MD024: false
MD013:
line_length: 120
code_blocks: false
tables: false
MD013: false
MD026: false
MD046: false # Mix of indented and fenced code blocks
MD004: false
Expand Down
7 changes: 1 addition & 6 deletions .markdownlintrc
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
{
"MD024": false,
"MD013": {
"line_length": 123,
"code_blocks": false,
"tables": false

},
"MD013": false,
"MD026": false,
"MD046": false,
"MD004": false
Expand Down
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@
"editor.wrappingIndent": "same",
"editor.wordWrapColumn": 120,
"editor.rulers": [120],
"editor.codeActionsOnSave": {
"source.fixAll.markdownlint": "always"
}
}
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,16 @@ We'll be working on follow-ups to make this more user-friendly, but it's now wor
* Open the root of the project (`/`, not `/docs`)
* Run `markdownlint-cli2 --config ".github/linters/.markdownlint.yml" "docs/**/*.md"`

We recommend adding the following settings to your VSCode environment if they don't come through in the repository:

```json
"editor.codeActionsOnSave": {
"source.fixAll.markdownlint": "always"
}
```

This will fix 80% of the markdown linting issues for you upon save.

We'd love your contributions! See [The contributing guide](CONTRIBUTING.md) for how to get involved.

## Building the API docs locally
Expand Down

0 comments on commit 4325c7d

Please sign in to comment.