Search code examples
javascriptgithubmarkdowngithub-flavored-markdown

GitHub: Render markdown in code comments / docblock?

Let's say I have a javascript file in github, and add some markdown to a comment block:

/**
 * # Markdown here?
 * - list?
 * */
function MyClass(){
  this.someMethod = function(){
    // this method is added to each new instance
    // for this reason, adding your methods here can bloat
  };  
}

Can I get doc-blocks or comment blocks to render as markdown?

Solution

  • No, that's not possible.

    However, you could create an external documentation using a tool like Sphinx - while it doesn't use markdown it uses ReStructured Text which is somewhat similar.