Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Custom rule - greyboxes/email templates need line breaks before ":::" #854

Closed
1 task
tiagov8 opened this issue Mar 8, 2024 · 1 comment
Closed
1 task
Assignees
Labels
type: feature New feature or request

Comments

@tiagov8
Copy link
Member

tiagov8 commented Mar 8, 2024

Cc: @bradystroud @adamcogan

Hi @tombui99

Pain

We have custom "classes" if you will in our Rules Markdown. For example, to add a greybox:

::: greybox
{{ TEXT }}
:::

❌ That won't work if you have a sentence right before it without a line break. E.g.

Some sentence.
::: greybox
{{ TEXT }}
:::

✅ The fix it, the line break must exist. E.g.

Some sentence.

::: greybox
{{ TEXT }}
:::

See an example of a broken rule that I fixed with Adam: SSWConsulting/SSW.Rules.Content#8099

Suggested Solution

  • 1. Can CodeAuditor check for the source Markdown of these pages and look for these errors?

Note: I think CodeAuditor only reads HTML as the browser, but we want to know if the above is possible.


Screenshot 2024-03-08 at 1 09 59 PM

Figure: The broken greybox we found

@tiagov8 tiagov8 added the type: feature New feature or request label Mar 8, 2024
@tombui99 tombui99 self-assigned this Mar 12, 2024
@tombui99
Copy link
Member

tombui99 commented Mar 14, 2024

cc @adamcogan @william-liebenberg

Hey @tiagov8

As per our conversation, we are working on a Markdown Auditor that will make this possible by checking all markdown files in a PR.

See #855

We will make sure we have this implemented on the new "Auditor" when it's ready.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants