search

thomvaill / log4brains

✍️ Log and publish your architecture decisions (ADR)
Apache License 2.0
1.13k stars 95 forks source link

html comments containing reference link defentions crash clientside renderer #111

Open anabelle2001 opened 1 year ago

anabelle2001 commented 1 year ago

Bug Report:

Description

HTML comments containing reference link definitions crash the preview window

Steps to Reproduce

  1. Add the following comment to anywhere in an ADR. <!--[^1]:https://example.com -->
  2. Open the ADR with log4brains preview / Reload the ADR if it's already open

Expected Behavior

Renderer does not crash, and also does not display commented text

Context

I was commenting out a reference link definition with my IDE. This issue came up when trying to do research to make a feature request to fully support reference links, including non-/\^[0-9]+/ shortcut reference links and implict reference links.

Environment