Document CommentDelimiters configuration option

[fviolette]

Featured in 3.8.0.
Original code contribution is vale-cli/vale#900

[netlify]

✅ Deploy Preview for eclectic-semifreddo-be083c ready!

Name	Link
🔨 Latest commit	4a85b76
🔍 Latest deploy log	https://app.netlify.com/sites/eclectic-semifreddo-be083c/deploys/6729e19524069f0009054e99
😎 Deploy Preview	https://deploy-preview-64--eclectic-semifreddo-be083c.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[jdkato]

Thanks for working on this.

The intended use case for this is to replace the use of HTML syntax, so an example would look something like this:

[formats]
mdx = md

[*.mdx]
BasedOnStyles = Vale

CommentDelimiters = {/*, */}

and then it would be used like so:

{/* vale off */}

This is some text ACT test

This is some text ACT test

{/* vale on */}

{/* vale vale.Redundancy = NO */}

This is some text ACT test

{/* vale vale.Redundancy = YES */}

See testdata/fixtures/comments for a complete example.

[fviolette]

Glad to hear this is how it should work (without the double HTML and the custom comment delimiters).

This is not working for me at the moment. I'm on macOS and using Vale 3.8.0.
The example I added was the only way to get it working (as a passthrough) but I'll update it as per your suggestion.

StylesPath = vale-styles

[formats]
mdx = md

[*.md]
BasedOnStyles = Vale

CommentDelimiters = {/*, */}

^ FWIW, [.mdx] or [.md] above produce the same. I also tried wrapping quotes around each comment delimiters.

{/* vale off */}

This is some text ACT test

This is some text ACT test

{/* vale on */}

{/* vale vale.Redundancy = NO */}

This is some text ACT test

{/* vale vale.Redundancy = YES */}

This is some text ACT test

This is some text ACT test

All 'ACT test' occurrences are firing for me.

Is there anything I'm doing wrong?

[fviolette]

I got the testdata to work so it is on my side. I'll update the document after I fix this.
Thanks for leading me into the right direction 👍

[fviolette]

Example updated.