debian-mirror-gitlab/doc/.vale/gitlab/AlertBoxStyle.yml

23 lines
1,017 B
YAML
Raw Normal View History

2020-07-28 23:09:34 +05:30
---
# Error: gitlab.AlertBoxStyle
#
# Makes sure alert boxes follow standard formatting.
#
2020-11-24 15:15:51 +05:30
# 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:**"
#
2020-07-28 23:09:34 +05:30
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
2020-10-24 23:57:45 +05:30
message: 'Alert box "%s" must use the formatting in the style guide.'
2020-07-28 23:09:34 +05:30
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
level: error
scope: raw
raw:
- '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
2020-10-24 23:57:45 +05:30
- '((NOTE: \*\*(NOTE|note):\*\*)|(TIP: \*\*(TIP|tip):\*\*)|(CAUTION: \*\*(CAUTION|caution):\*\*)|(DANGER: \*\*(DANGER|danger):\*\*))|'
- '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
- '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'