Add icons to alerts

errata-ai · Jan 30, 2024 · a418954 · a418954
1 parent 426fe4e
commit a418954
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 27 deletions.
diff --git a/content/en/docs/topics/config/index.md b/content/en/docs/topics/config/index.md
@@ -112,9 +112,7 @@ WordTemplate = \b(?:%s)\b
 
 ### Format associations
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< alert icon="👉" context="info">}}
 After making a format assignment, the configuration of the *assigned* format is 
 now applied from your `.vale.ini` file.
 
@@ -176,9 +174,7 @@ Style1.Rule2 = error
 
 #### BlockIgnores
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< alert icon="👉" context="info">}}
 `BlockIgnores` are only supported in **Markdown**, **reStructuredText**, **AsciiDoc**, 
   and **Org Mode**.
 
@@ -207,9 +203,7 @@ BlockIgnores = (?s) *({< output >}.*?{< ?/ ?output >}), \
 
 #### TokenIgnores
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< icon="👉" alert context="info">}}
 `TokenIgnores` are only supported in **Markdown**, **reStructuredText**, **AsciiDoc**, 
   and **Org Mode**.
 
@@ -266,6 +260,10 @@ This is some text
 
 ### reStructuredText
 
+{{< alert icon="👉" >}}
+Commenting out headers/headings isn't currently supported. See [issues/340](https://github.com/errata-ai/vale/issues/340) for more information.
+{{< /alert >}}
+
 reStructuredText uses its own comment style:
 
 ```text
@@ -288,10 +286,6 @@ This is some text
 # vale on
 ```
 
-{{< alert icon="👉" >}}
-Commenting out headers/headings isn't currently supported. See [issues/340](https://github.com/errata-ai/vale/issues/340) for more information.
-{{< /alert >}}
-
 ### AsciiDoc
 
 AsciiDoc uses HTML-style comments with its pass-through functionality:
@@ -308,7 +302,7 @@ This is a steward that raises an alert.
 
 ## Search process
 
-{{< alert icon="👉" >}}
+{{< alert icon="👉" context="info" >}}
 You can override the default search process by manually specifying a path using
 the [--config](/manual/config/) option or by defining a `VALE_CONFIG_PATH` environment variable.
 {{< /alert >}}

diff --git a/content/en/docs/topics/scoping/index.md b/content/en/docs/topics/scoping/index.md
@@ -203,8 +203,6 @@ configuration) in your source code comments.
 ## Non-standard markup
 
 {{< alert context="info">}}
-**Heads up**!
-
 Ignore patterns are a low-level concept that have a few important restrictions:
 
 - They are only supported in **Markdown**, **reStructuredText**, **AsciiDoc**, 

diff --git a/content/en/docs/topics/styles/index.md b/content/en/docs/topics/styles/index.md
@@ -56,18 +56,14 @@ styles/
 where _base_, _blog_, and _docs_ are your styles that each contain certain
 rules.
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< alert icon="👉" context="warning">}}
 Make sure your rule files end in extension `.yml`. Do not end them in `.yaml`,
 as Vale will not detect them.
 {{< /alert >}}
 
 ## Extension points
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< alert icon="👉" context="info">}}
 In addition to the standard Go [regex syntax][1], Vale also
 supports positive lookahead (`(?=re)`), negative lookahead (`(?!re)`),
 positive lookbehind (`(?<=re)`), and negative lookbehind (`(?<!re)`).
@@ -571,9 +567,7 @@ skip: 3
 
 ### script
 
-{{< alert context="info">}}
-**Heads up**!
-
+{{< alert icon="👉" context="warning">}}
 When using `script`-based rules, you're limited to the standard Go [regex syntax][1].
 
 [1]: https://pkg.go.dev/regexp/syntax

diff --git a/content/en/docs/topics/vocab/index.md b/content/en/docs/topics/vocab/index.md
@@ -58,8 +58,6 @@ without having to re-implement them.
 ## Folder structure
 
 {{< alert context="info">}}
-**Heads up**!
-
 In versions of Vale prior to 3.0, vocabularies were stored in 
 `<StylesPath>/Vocab`. When upgrading from an older version of Vale, you'll need 
 to move your vocabularies to the new `<StylesPath>/config/vocabularies`