gitlab-org--gitlab-foss/doc/.vale/gitlab/AlertBoxStyle.yml

18 lines
697 B
YAML

---
# Error: gitlab.AlertBoxStyle
#
# Makes sure alert boxes follow standard formatting.
#
# Checks for 2 formatting issues:
# - 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
extends: existence
message: 'Alert box "%s" must use the formatting in the style guide.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
level: error
scope: raw
raw:
- '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
- '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'