Skip to content

Commit

Permalink
Add a Vale rule to check for admonitions of type :::note (#2143) (#…
Browse files Browse the repository at this point in the history
…2146)

* chore: Start creating a custom vale rule

* chore: Add a custom Vale rule to check admonitions

(cherry picked from commit 73c52e2)

Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
  • Loading branch information
1 parent 947d7de commit 2fbbb11
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions vale/styles/spectrocloud/admonitions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: substitution
message: "The ':::note' admonition is not approved under the Spectro Cloud style guide. Consider using ':::info' or another approved admonition."
link: https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions/Callouts
level: error
nonword: true
ignorecase: true
swap:
":::note": ":::info"

0 comments on commit 2fbbb11

Please sign in to comment.