jonschlinkert / grunt-readme

DEPRECATED. Use Verb instead
https://github.com/assemble/verb
Other
30 stars 10 forks source link

feature request: comments in MD templates #36

Closed bahmutov closed 10 years ago

jonschlinkert commented 10 years ago

what format would you want to use? If the comments are formatted as lodash templates it would be pretty straightforward - or if we use a special syntax for them we can strip them with regex (keeping in mind that code comments are often in code examples, and we wouldn't want those to be stripped).

what are your thoughts?

bahmutov commented 10 years ago

I am thinking something specific to MD template, removed using regex. For example %%% at the start of the line

jonschlinkert commented 10 years ago

Let me know if this works for you: https://github.com/assemble/grunt-readme/blob/master/DOCS.md#code-comments

Reopen if you think it's not resolved