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

HTML reporting shows Markdown notation and extra line breaks #604

Closed
Tracked by #696
schrolla opened this issue Oct 17, 2023 · 1 comment · Fixed by #730
Closed
Tracked by #696

HTML reporting shows Markdown notation and extra line breaks #604

schrolla opened this issue Oct 17, 2023 · 1 comment · Fixed by #730
Assignees
Labels
bug This issue or pull request addresses broken functionality
Milestone

Comments

@schrolla
Copy link
Collaborator

🐛 Summary

The ScubaGear HTML reporter now pulls policy requirements directly from the associated baseline markdown files. As a result, any formatting present in those files is carried forward into the report without rendering or adjustment. This means that line breaks ignored in markdown are shown in the HTML report and result in odd line break locations depending on the user's screen width. Additionally, markdown notation is not rendered and is shown as is which can make the requirement text harder to interpret or at the very least is less visually appealing.
The extraneous line breaks and markdown notation should be removed and/or rendered appropriately in the HTML report.

To reproduce

Steps to reproduce the behavior:

  1. Generate a report via the Invoke-Scuba command
  2. Review a baseline report, particularly the M365 Defender report at MS.DEFENDER.4.1v1 and MS.DEFENDER.5.1v1

Expected behavior

The expectation was that the policy requirement text would be rendered in a way that word wrap occurs based on the width of the cell in the HTML report, not on a strict boundary from the markdown baseline file. Additionally, the markdown notation should have either been removed or rendered.

Any helpful log output or screenshots

Screenshot 2023-10-17 at 11 43 14 AM

@schrolla schrolla added the bug This issue or pull request addresses broken functionality label Oct 17, 2023
@schrolla
Copy link
Collaborator Author

Note that this is similar and likely should be resolved along with the previously reported Unicode/special character bug reported in #216

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue or pull request addresses broken functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants