search

jonschlinkert / parse-comments

Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
https://github.com/jonschlinkert
MIT License
66 stars 23 forks source link

Fixed README.md #18

Closed ekschro closed 2 years ago

ekschro commented 4 years ago

There seemed to be js code blocks that were opened and closed in the wrong areas. This resulted in the literal MarkDown syntax being printed.

tunnckoCore commented 4 years ago

Thanks for this. But the thing is that the readme is auto-generated from .verb.md plus actual source code comments. So, the bug is probably because it's tricky to write markdown in a code comment.

So the changes should be done in the code comments instead of the readme.

ekschro commented 4 years ago

I see 😂 That completely went over my head.

ekschro commented 4 years ago

Issue So, the issue was the the jsdoc examples found in the literal jsdoc in index.js were breaking the Verb generated MarkDown. This was because the jsdoc examples were not enclosed in block comments.

Solution Block comments were not working inside the MarkDown JS code blocks... So I simply used single line comments!

tunnckoCore commented 4 years ago

I don't think it's better. It's quite obvious what it shows currently in the readme, no matter the syntax highlighting problems.

ekschro commented 4 years ago

I thought it at least avoided the corruption of the About section... But I understand.