diff --git a/.github/linters/.markdownlint.yml b/.github/linters/.markdownlint.yml index 01dbaabc1..7bc093fed 100644 --- a/.github/linters/.markdownlint.yml +++ b/.github/linters/.markdownlint.yml @@ -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 diff --git a/.markdownlintrc b/.markdownlintrc index d9509f680..ca285c6af 100644 --- a/.markdownlintrc +++ b/.markdownlintrc @@ -1,11 +1,6 @@ { "MD024": false, - "MD013": { - "line_length": 123, - "code_blocks": false, - "tables": false - - }, + "MD013": false, "MD026": false, "MD046": false, "MD004": false diff --git a/.vscode/settings.json b/.vscode/settings.json index b6cc11639..1058d3f38 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -20,4 +20,7 @@ "editor.wrappingIndent": "same", "editor.wordWrapColumn": 120, "editor.rulers": [120], + "editor.codeActionsOnSave": { + "source.fixAll.markdownlint": "always" + } } \ No newline at end of file diff --git a/README.md b/README.md index 5c4c72321..761a102f7 100644 --- a/README.md +++ b/README.md @@ -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