refactor: rename to_markdown_string to to_markdown and update related function calls

Author: yordis

lib/ex_doc/doc_ast.ex

@@ -71,22 +71,22 @@ defmodule ExDoc.DocAST do
   The optional `fun` argument allows post-processing each AST node
   after it's been converted to markdown.
   """
-  def to_markdown_string(ast, fun \\ fn _ast, string -> string end)
+  def to_markdown(ast, fun \\ fn _ast, string -> string end)
 
-  def to_markdown_string(binary, _fun) when is_binary(binary) do
+  def to_markdown(binary, _fun) when is_binary(binary) do
     ExDoc.Utils.h(binary)
   end
 
-  def to_markdown_string(list, fun) when is_list(list) do
-    result = Enum.map_join(list, "", &to_markdown_string(&1, fun))
+  def to_markdown(list, fun) when is_list(list) do
+    result = Enum.map_join(list, "", &to_markdown(&1, fun))
     fun.(list, result)
   end
 
-  def to_markdown_string({:comment, _attrs, inner, _meta} = ast, fun) do
+  def to_markdown({:comment, _attrs, inner, _meta} = ast, fun) do
     fun.(ast, "<!--#{inner}-->")
   end
 
-  def to_markdown_string({:code, attrs, inner, _meta} = ast, fun) do
+  def to_markdown({:code, attrs, inner, _meta} = ast, fun) do
     lang = attrs[:class] || ""
 
     result = """
@@ -98,44 +98,50 @@ defmodule ExDoc.DocAST do
     fun.(ast, result)
   end
 
-  def to_markdown_string({:a, attrs, inner, _meta} = ast, fun) do
-    result = "[#{to_markdown_string(inner, fun)}](#{attrs[:href]})"
+  def to_markdown({:a, attrs, inner, _meta} = ast, fun) do
+    result = "[#{to_markdown(inner, fun)}](#{attrs[:href]})"
     fun.(ast, result)
   end
 
-  def to_markdown_string({:hr, _attrs, _inner, _meta} = ast, fun) do
+  def to_markdown({:hr, _attrs, _inner, _meta} = ast, fun) do
     result = "\n\n---\n\n"
     fun.(ast, result)
   end
 
-  def to_markdown_string({tag, _attrs, _inner, _meta} = ast, fun) when tag in [:p, :br] do
+  def to_markdown({:p, _attrs, inner, _meta} = ast, fun) do
+    result = to_markdown(inner, fun) <> "\n\n"
+    fun.(ast, result)
+  end
+
+  def to_markdown({:br, _attrs, _inner, _meta} = ast, fun) do
     result = "\n\n"
     fun.(ast, result)
   end
 
-  def to_markdown_string({:img, attrs, _inner, _meta} = ast, fun) do
+  def to_markdown({:img, attrs, _inner, _meta} = ast, fun) do
     alt = attrs[:alt] || ""
     title = attrs[:title] || ""
     result = "![#{alt}](#{attrs[:src]} \"#{title}\")"
     fun.(ast, result)
   end
 
   # ignoring these: area base col command embed input keygen link meta param source track wbr
-  def to_markdown_string({tag, _attrs, _inner, _meta} = ast, fun) when tag in @void_elements do
+  def to_markdown({tag, _attrs, _inner, _meta} = ast, fun) when tag in @void_elements do
     result = ""
     fun.(ast, result)
   end
 
-  def to_markdown_string({_tag, _attrs, inner, %{verbatim: true}} = ast, fun) do
+  def to_markdown({_tag, _attrs, inner, %{verbatim: true}} = ast, fun) do
     result = Enum.join(inner, "")
     fun.(ast, result)
   end
 
-  def to_markdown_string({_tag, _attrs, inner, _meta} = ast, fun) do
-    result = to_markdown_string(inner, fun)
+  def to_markdown({_tag, _attrs, inner, _meta} = ast, fun) do
+    result = to_markdown(inner, fun)
     fun.(ast, result)
   end
 
+
   ## parse markdown
 
   defp parse_markdown(markdown, opts) do

lib/ex_doc/formatter.ex

@@ -137,10 +137,10 @@ defmodule ExDoc.Formatter do
     mod_id <> "." <> id
   end
 
-  defp autolink_and_render(doc, ".md", language, autolink_opts, _opts) do
+  defp autolink_and_render(doc, ".md", language, autolink_opts, opts) do
     doc
     |> language.autolink_doc(autolink_opts)
-    |> ExDoc.DocAST.to_markdown_string()
+    |> ExDoc.DocAST.highlight(language, opts)
   end
 
   defp autolink_and_render(doc, _html_ext, language, autolink_opts, opts) do

lib/ex_doc/formatter/markdown/templates.ex

@@ -39,6 +39,12 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
     static_file |> Path.basename() |> text_to_id()
   end
 
+  def node_doc(%{doc: doc}) when is_list(doc) do
+    # Handle DocAST by converting to markdown
+    ExDoc.DocAST.to_markdown(doc)
+  end
+
+  def node_doc(%{doc: doc}) when is_binary(doc), do: doc
   def node_doc(%{source_doc: %{"en" => source}}) when is_binary(source), do: source
   def node_doc(%{rendered_doc: source}) when is_binary(source), do: source