CoffeeScript comments and Markdown about docker HOT 5 OPEN

I currently have a workaround to write my titles with Markdown in my CoffeeScripts comments.

# ### My title in H3
###
My Block Comments
###

This works but it does not generate exactly the documentation that will normaly be done when you set the title inside the block comment. It generates the title, a line and the block comment.

from docker.

Auch, just got bit by the same feature.
Just as I thought I was done writing API docs.

from docker.

+1

from docker.

+1

from docker.

To overcome this problem I introduced the following syntax in my code tool:

###
#3 Heading level 3
###

The reader will transform this to the correct markdown befor transmormation. The same also goes for headings level 4-6.

The code therefore looks like:

text = text.replace /(\n\s*)#([1-6])(\s+)/, (_, pre, num, post) ->
  "#{pre}#{util.string.repeat '#', num}#{post}"

Maybe a similiar replacement can be added to docker, too.

from docker.