From 8df00cf0717184f3c8216fd36ceb925af4324876 Mon Sep 17 00:00:00 2001 From: David Anson Date: Mon, 9 Sep 2024 22:53:37 -0700 Subject: [PATCH] Clarify documentation for automatically-fixable rules in README.md (refs #348). --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 09c81e8..f67a9f9 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ The following rules can be automatically fixed by moving the cursor to a rule vi ### Fix -All of a document's violations of the above rules can be fixed automatically. +All of a document's violations of the automatically-fixable rules above can be fixed for you. `markdownlint` registers itself as a [source code formatter](https://code.visualstudio.com/docs/editor/codebasics#_formatting) for Markdown files and can be invoked by the `Format Document`/`editor.action.formatDocument` and `Format Selection`/`editor.action.formatSelection` commands, either from the [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (via `View|Command Palette...` or `Ctrl+Shift+P`/`Ctrl+Shift+P`/`⇧⌘P`) or via the default key bindings of `Shift+Alt+F`/`Ctrl+Shift+I`/`⇧⌥F` (to format the document) and `Ctrl+K Ctrl+F`/`Ctrl+K Ctrl+F`/`⌘K ⌘F` (to format the selection). To automatically format when saving or pasting into a Markdown document, [configure Visual Studio Code's `editor.formatOnSave` or `editor.formatOnPaste` settings](https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings) like so: