Skip to content

Commit

Permalink
Clarify documentation for automatically-fixable rules in README.md (r…
Browse files Browse the repository at this point in the history
…efs #348).
  • Loading branch information
DavidAnson committed Sep 10, 2024
1 parent 4f88196 commit 8df00cf
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 8df00cf

Please sign in to comment.