summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab/GitLabFlavoredMarkdown.yml')
-rw-r--r--doc/.vale/gitlab/GitLabFlavoredMarkdown.yml14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml b/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml
new file mode 100644
index 00000000000..532f1afd816
--- /dev/null
+++ b/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml
@@ -0,0 +1,14 @@
+---
+# Warning: gitlab.GitLabFlavoredMarkdown
+#
+# Checks for unclear use of GLFM or GLM instead of GitLab/GitHub Flavored Markdown
+#
+# For a list of all options, see https://vale.sh/docs/topics/styles/
+extends: substitution
+message: "Use '%s' instead of '%s' when possible."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
+level: warning
+ignorecase: true
+swap:
+ GLFM: "GitLab Flavored Markdown"
+ GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown"