Commit a7d38a45 authored by Marcel Amirault's avatar Marcel Amirault Committed by Suzanne Selhorn

Clarify what the vale alert box rule does

parent adf566cd
...@@ -3,6 +3,12 @@ ...@@ -3,6 +3,12 @@
# #
# Makes sure alert boxes follow standard formatting. # Makes sure alert boxes follow standard formatting.
# #
# Checks for 4 known issues:
# - Alert boxes with no colon, or colon outside the bold text
# - Known incorrect capitalization of the most commonly used alert box text
# - Alert boxes with the note text on the same line
# - Alert boxes using blockquote formatting, like "> **Note:**"
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence extends: existence
message: 'Alert box "%s" must use the formatting in the style guide.' message: 'Alert box "%s" must use the formatting in the style guide.'
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment