doc/docdown: render mdoc as markdown

[nit.git] / src / doc / doc_down.nit

diff --git a/src/doc/doc_down.nit b/src/doc/doc_down.nit
index 9bb75af..5951f8e 100644 (file)
--- a/src/doc/doc_down.nit
+++ b/src/doc/doc_down.nit
@@ -28,17 +28,17 @@ redef class MDoc
        var comment: String is lazy do
                var lines = content.to_a
                if not lines.is_empty then lines.shift
-               return content.join("\n").html_escape
+               return lines.join("\n")
        end
 
        # Full comment HTML escaped.
-       var documentation: String is lazy do return content.join("\n").html_escape
+       var documentation: String is lazy do return content.join("\n")
 
-       private var markdown_proc: MarkdownProcessor is lazy do
+       private var markdown_proc: MarkdownProcessor is lazy, writable do
                return original_mentity.as(not null).model.nitdoc_md_processor
        end
 
-       private var inline_proc: MarkdownProcessor is lazy do
+       private var inline_proc: MarkdownProcessor is lazy, writable do
                return original_mentity.as(not null).model.nitdoc_inline_processor
        end
 
@@ -48,7 +48,12 @@ redef class MDoc
                var syn = inline_proc.process(content.first)
                res.add "<span class=\"synopsys nitdoc\">{syn}</span>"
                return res
+       end
 
+       # Renders the synopsis as a HTML comment block.
+       var md_synopsis: Writable is lazy do
+               if content.is_empty then return ""
+               return content.first
        end
 
        # Renders the comment without the synopsis as a HTML comment block.
@@ -58,13 +63,24 @@ redef class MDoc
                return lines_to_html(lines)
        end
 
+       #
+       var md_comment: Writable is lazy do
+               if content.is_empty then return ""
+               var lines = content.to_a
+               lines.shift
+               return lines.join("\n")
+       end
+
        # Renders the synopsis and the comment as a HTML comment block.
        var html_documentation: Writable is lazy do return lines_to_html(content.to_a)
 
+       # Renders the synopsis and the comment as a HTML comment block.
+       var md_documentation: Writable is lazy do return lines_to_md(content.to_a)
+
        # Renders markdown line as a HTML comment block.
        private fun lines_to_html(lines: Array[String]): Writable do
                var res = new Template
-               var decorator = markdown_proc.emitter.decorator.as(NitdocDecorator)
+               var decorator = markdown_proc.decorator.as(NitdocDecorator)
                decorator.current_mdoc = self
                res.add "<div class=\"nitdoc\">"
                # do not use DocUnit as synopsys
@@ -73,7 +89,7 @@ redef class MDoc
                           not lines.first.has_prefix("\t") then
                                # parse synopsys
                                var syn = inline_proc.process(lines.shift)
-                               res.add "<p class=\"synopsys\">{syn}</p>"
+                               res.add "<h1 class=\"synopsys\">{syn}</h1>"
                        end
                end
                # check for annotations
@@ -92,7 +108,20 @@ redef class MDoc
                res.add "</div>"
                decorator.current_mdoc = null
                return res
+       end
 
+       private fun lines_to_md(lines: Array[String]): Writable do
+               var res = new Template
+               if not lines.is_empty then
+                       var syn = lines.first
+                       if not syn.has_prefix("    ") and not syn.has_prefix("\t") and
+                         not syn.trim.has_prefix("#") then
+                               lines.shift
+                               res.add "# {syn}\n"
+                       end
+               end
+               res.add lines.join("\n")
+               return res
        end
 end
 
@@ -197,18 +226,18 @@ end
 
 redef class Model
        # Get a markdown processor for Nitdoc comments.
-       var nitdoc_md_processor: MarkdownProcessor is lazy do
+       var nitdoc_md_processor: MarkdownProcessor is lazy, writable do
                var proc = new MarkdownProcessor
-               proc.emitter.decorator = new NitdocDecorator
+               proc.decorator = new NitdocDecorator
                return proc
        end
 
        # Get a markdown inline processor for Nitdoc comments.
        #
        # This processor is specificaly designed to inlinable doc elements like synopsys.
-       var nitdoc_inline_processor: MarkdownProcessor is lazy do
+       var nitdoc_inline_processor: MarkdownProcessor is lazy, writable do
                var proc = new MarkdownProcessor
-               proc.emitter.decorator = new InlineDecorator
+               proc.decorator = new InlineDecorator
                return proc
        end
 end