Skip to content

[feature suggestion] alternative comment format using the reference style links syntax #15

@songqiang

Description

@songqiang

First of all, thanks a lot for this extension, which really simplified my AI workflow!

Problem

Similar to the issues #13 and #2, The current comment syntax:

:comment[Data Locations]{#comment-1773879845866 text="comment__NEWLINE__"}

renders as visible, non-standard markup in VS Code and other Markdown viewers:

:comment[Data Locations]

This is unfriendly for readers and breaks the reading experience, especially when comments are left unresolved for future reference. Related: #13, #2.

Proposed solution

Support an alternative comment format that hijacks Markdown's reference link syntax, which renderers silently ignore:

Original text in markdown 

[#comment-1]: # (text="Original text in markdown" comment="comment")

This renders cleanly in any standard Markdown viewer as:

Original text in markdown 

The extension would parse these reference-link comments and display them in its UI just like the existing :comment[...] syntax.

I guess you may already think about such things, and would like to know if there are some corner cases making the proposal solution not working properly

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions