From d89dee975228ae261d22c15adcd03578634d429c Mon Sep 17 00:00:00 2001 From: Joseph Kato Date: Tue, 15 Oct 2024 11:28:36 -0700 Subject: [PATCH] Add note about deps --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index a7af5c5e..ab06f965 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ ## Usage +> [!NOTE] +> If you're using a markup format other than Markdown, you may need to install +> an external parser. For more information, see the [Vale documentation][2]. + Add the following (or similar) to one of your [`.github/workflows`][1] files: ```yaml @@ -149,3 +153,4 @@ with: ``` [1]: https://help.github.com/en/github/automating-your-workflow-with-github-actions/configuring-a-workflow +[2]: https://vale.sh/docs/topics/scoping/#formats