WIP for elixir-lang#1976

lib/ex_doc.ex

@@ -44,6 +44,7 @@ defmodule ExDoc do
     if Code.ensure_loaded?(modname) do
       modname
     else
+      IO.inspect(modname)
       raise "formatter module #{inspect(argname)} not found"
     end
   end

lib/ex_doc/cli.ex

@@ -103,7 +103,7 @@ defmodule ExDoc.CLI do
   defp normalize_formatters(opts) do
     formatters =
       case Keyword.get_values(opts, :formatter) do
-        [] -> opts[:formatters] || ["html", "epub", "markdown"]
+        [] -> opts[:formatters] || ["html", "epub"]
         values -> values
       end
 

lib/ex_doc/formatter/html/templates/footer_template.eex

@@ -22,6 +22,12 @@
               Download ePub version
             </a>
           <% end %>
+
+          <%= if "markdown" in config.formatters do %>
+            <a href="<%= config.project %>-markdown.zip" title="Markdown version">
+              Download Markdown version
+            </a>
+          <% end %>
         </span>
       </p>
 

lib/ex_doc/formatter/html/templates/module_template.eex

@@ -9,6 +9,14 @@
         <span class="sr-only">View Source</span>
       </a>
     <% end %>
+    <%= if "markdown" in config.formatters do %>
+      <a href="<%= config.project %>-markdown.zip" title="Markdown version">
+        <%= IO.inspect(module).title %>
+        <i class="ri-markdown-line" aria-hidden="true"></i>
+        <span class="sr-only">Download Markdown version</span>
+      </a>
+    <% end %>
+
     <span translate="no"><%= module.title %></span> <%= module_type(module) %>
     <small class="app-vsn" translate="no">(<%= config.project %> v<%= config.version %>)</small>
     <%= for annotation <- module.annotations do %>

lib/ex_doc/formatter/markdown.ex

@@ -1,7 +1,6 @@
-defmodule ExDoc.Formatter.Markdown do
+defmodule ExDoc.Formatter.MARKDOWN do
   @moduledoc false
 
-  @mimetype "text/markdown"
   @assets_dir "MD/assets"
   alias __MODULE__.{Assets, Templates}
   alias ExDoc.Formatter.HTML
@@ -28,24 +27,24 @@ defmodule ExDoc.Formatter.Markdown do
 
     extras =
       config
-      |> HTML.build_extras(".xhtml")
+      |> HTML.build_extras(".md")
       |> Enum.chunk_by(& &1.group)
       |> Enum.map(&{hd(&1).group, &1})
 
     config = %{config | extras: extras}
 
-    static_files = HTML.generate_assets("MD", default_assets(config), config)
-    HTML.generate_logo(@assets_dir, config)
-    HTML.generate_cover(@assets_dir, config)
-
-    # generate_nav(config, nodes_map)
+    generate_nav(config, nodes_map) 
     generate_extras(config)
     generate_list(config, nodes_map.modules)
     generate_list(config, nodes_map.tasks)
 
-    {:ok, epub} = generate_zip(config.output)
-    File.rm_rf!(config.output)
-    Path.relative_to_cwd(epub)
+    # if config[:generate_zip] do # TODO: add a command line flag?
+    #   {:ok, zip} = generate_zip(config.output)
+    #   File.rm_rf!(config.output)
+    #   Path.relative_to_cwd(zip)
+    # else
+      config.output |> Path.join("index.md") |> Path.relative_to_cwd()
+    # end
   end
 
   defp normalize_config(config) do
@@ -57,6 +56,23 @@ defmodule ExDoc.Formatter.Markdown do
     %{config | output: output}
   end
 
+  defp normalize_output(output) do
+    output
+    |> String.replace(~r/\r\n|\r|\n/, "\n")
+    |> String.replace(~r/\n{2,}/, "\n") 
+  end
+
+  defp generate_nav(config, nodes) do
+    nodes =
+      Map.update!(nodes, :modules, fn modules ->
+        modules |> Enum.chunk_by(& &1.group) |> Enum.map(&{hd(&1).group, &1})
+      end)
+
+    content = Templates.nav_template(config, nodes)
+    |> normalize_output()
+    File.write("#{config.output}/MD/index.md", content)
+  end
+
   defp generate_extras(config) do
     for {_title, extras} <- config.extras do
       Enum.each(extras, fn %{id: id, title: title, title_content: _title_content, source: content} ->
@@ -66,6 +82,7 @@ defmodule ExDoc.Formatter.Markdown do
 
         #{content}
         """
+        |> normalize_output()
 
         if File.regular?(output) do
           Utils.warn("file #{Path.relative_to_cwd(output)} already exists", [])
@@ -77,8 +94,6 @@ defmodule ExDoc.Formatter.Markdown do
   end
 
 
-
-
   defp generate_list(config, nodes) do
     nodes
     |> Task.async_stream(&generate_module_page(&1, config), timeout: :infinity)
@@ -99,13 +114,6 @@ defmodule ExDoc.Formatter.Markdown do
 
   ## Helpers
 
-  defp default_assets(config) do
-    [
-      {Assets.dist(config.proglang), "MD/dist"},
-      {Assets.metainfo(), "META-INF"}
-    ]
-  end
-
   defp files_to_add(path) do
     Enum.reduce(Path.wildcard(Path.join(path, "**/*")), [], fn file, acc ->
       case File.read(file) do
@@ -120,6 +128,7 @@ defmodule ExDoc.Formatter.Markdown do
 
   defp generate_module_page(module_node, config) do
     content = Templates.module_page(config, module_node)
+    |> normalize_output()
     File.write("#{config.output}/MD/#{module_node.id}.md", content)
   end
 

lib/ex_doc/formatter/markdown/assets.ex

@@ -1,4 +1,4 @@
-defmodule ExDoc.Formatter.Markdown.Assets do
+defmodule ExDoc.Formatter.MARKDOWN.Assets do
   @moduledoc false
 
   defmacrop embed_pattern(pattern) do

lib/ex_doc/formatter/markdown/templates.ex

@@ -1,10 +1,10 @@
-defmodule ExDoc.Formatter.Markdown.Templates do
+defmodule ExDoc.Formatter.MARKDOWN.Templates do
   @moduledoc false
 
   require EEx
 
   import ExDoc.Utils,
-    only: [before_closing_body_tag: 2, before_closing_head_tag: 2, h: 1, text_to_id: 1]
+    only: [before_closing_body_tag: 2, h: 1, text_to_id: 1]
 
   alias ExDoc.Formatter.HTML.Templates, as: H
 
@@ -119,48 +119,34 @@ defmodule ExDoc.Formatter.Markdown.Templates do
     trim: true
   )
 
-  # @doc """
-  # Creates the table of contents.
-
-  # This template follows the EPUB Navigation Document Definition.
-
-  # See http://www.idpf.org/epub/30/spec/epub30-contentdocs.html#sec-xhtml-nav.
-  # """
-  # EEx.function_from_file(
-  #   :def,
-  #   :nav_template,
-  #   Path.expand("templates/nav_template.eex", __DIR__),
-  #   [:config, :nodes],
-  #   trim: true
-  # )
+  @doc """
+  Creates the table of contents.
 
-  # @doc """
-  # Creates a new chapter when the user provides additional files.
-  # """
-  # EEx.function_from_file(
-  #   :def,
-  #   :extra_template,
-  #   Path.expand("templates/extra_template.eex", __DIR__),
-  #   [:config, :title, :title_content, :content],
-  #   trim: true
-  # )
+  """
+  EEx.function_from_file(
+    :def,
+    :nav_template,
+    Path.expand("templates/nav_template.eex", __DIR__),
+    [:config, :nodes],
+    trim: true
+  )
 
 
-  # EEx.function_from_file(
-  #   :defp,
-  #   :nav_item_template,
-  #   Path.expand("templates/nav_item_template.eex", __DIR__),
-  #   [:name, :nodes],
-  #   trim: true
-  # )
+  EEx.function_from_file(
+    :defp,
+    :nav_item_template,
+    Path.expand("templates/nav_item_template.eex", __DIR__),
+    [:name, :nodes],
+    trim: true
+  )
 
-  # EEx.function_from_file(
-  #   :defp,
-  #   :nav_grouped_item_template,
-  #   Path.expand("templates/nav_grouped_item_template.eex", __DIR__),
-  #   [:nodes],
-  #   trim: true
-  # )
+  EEx.function_from_file(
+    :defp,
+    :nav_grouped_item_template,
+    Path.expand("templates/nav_grouped_item_template.eex", __DIR__),
+    [:nodes],
+    trim: true
+  )
 
   # EEx.function_from_file(
   #   :defp,
@@ -170,17 +156,6 @@ defmodule ExDoc.Formatter.Markdown.Templates do
   #   trim: true
   # )
 
-  # "templates/media-types.txt"
-  # |> Path.expand(__DIR__)
-  # |> File.read!()
-  # |> String.split("\n", trim: true)
-  # |> Enum.each(fn line ->
-  #   [extension, media] = String.split(line, ",")
-
-  #   def media_type("." <> unquote(extension)) do
-  #     unquote(media)
-  #   end
-  # end)
 
   # def media_type(_arg), do: nil
 

lib/ex_doc/formatter/markdown/templates/nav_grouped_item_template.eex

@@ -0,0 +1,8 @@
+<%= for {title, nodes} <- nodes do %>
+<%= if title do %>
+- <%=h to_string(title) %>
+<% end %>
+<%= for node <- nodes do %>
+  - [<%=h node.title %>](<%= URI.encode node.id %>.md)
+<% end %>
+<% end %>

lib/ex_doc/formatter/markdown/templates/nav_item_template.eex

@@ -0,0 +1,6 @@
+<%= unless Enum.empty?(nodes) do %>
+- <%= name %>
+<%= for node <- nodes do %>
+1. [<%=h node.title %>](<%= URI.encode node.id %>.md)
+<% end %>
+<% end %>

lib/ex_doc/formatter/markdown/templates/nav_template.eex

@@ -0,0 +1,9 @@
+# Table of contents
+
+<%= nav_grouped_item_template config.extras  %>
+<%= unless Enum.empty?(nodes.modules) do %>
+## Modules
+<%= nav_grouped_item_template nodes.modules  %>    
+<% end %>
+<%= nav_item_template "Mix Tasks", nodes.tasks %>
+<%= before_closing_body_tag(config, :markdown) %>