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

Markdown comments #91

Closed
linhtto opened this issue Sep 3, 2018 · 3 comments
Closed

Markdown comments #91

linhtto opened this issue Sep 3, 2018 · 3 comments
Assignees

Comments

@linhtto
Copy link

linhtto commented Sep 3, 2018

This is a follow-up to #53.

I think both of the ways mentioned in the above issued on commenting in Markdown work. Maybe you can support both?

Way 1: <!-- COMMENT GOES HERE -->
Way 2: [comment]: # "COMMENT GOES HERE"

In fact, VSCode recognizes Way 1 as a default type of comment, and it even greys it out. Way 2 works too (i.e., it won't show up in the output), but it's not greyed out by VSCode.

Another note is that if you do ctrl + / in VSCode it'll also go for Way 1, so it's likely the default.

@aaron-bond
Copy link
Owner

I think way 1 is partially doable with the parser in its current form. The only problem is that it'll detect the --> as part of the comment and highlight that too, which probably isn't the best.

way 2 is definitely doable but not at the same time as the first.

In saying that, I could maybe expand the block comment parsing to include the first, and grab the second as a single line comment. I'll take a look :)

@aaron-bond aaron-bond self-assigned this Sep 3, 2018
@linhtto
Copy link
Author

linhtto commented Sep 3, 2018 via email

@tomcharter365
Copy link

Seems like the fix to support markdown might be similar to how HTML is supported? Once I get some time I will see if I can get it to work that way and if successful I will do a pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants