update footer links & md tests

Author: mayel

lib/ex_doc/formatter/html/templates.ex

@@ -209,6 +209,21 @@ defmodule ExDoc.Formatter.HTML.Templates do
 
   defp relative_asset([h | _], output, _pattern), do: Path.relative_to(h, output)
 
+  defp get_hex_url(config, source_path) do
+    case config.package do
+      nil ->
+        nil
+
+      package ->
+        base_url = "https://preview.hex.pm/preview/#{package}/#{config.version}"
+        if source_path, do: "#{base_url}/show/#{source_path}", else: base_url
+    end
+  end
+
+  defp get_markdown_path(node) do
+    if node && node.id, do: URI.encode(node.id), else: "index"
+  end
+
   # TODO: Move link_headings and friends to html.ex or even to autolinking code,
   # so content is built with it upfront instead of added at the template level.
 

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

@@ -1,33 +1,43 @@
     <footer class="footer">
       <p>
-        <%= if config.package do %>
-          <span class="line">
-            <a href="https://hex.pm/packages/<%= config.package %>/<%= config.version %>" class="footer-hex-package">Hex Package</a>
+        <span class="line">
 
-            <a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>">Hex Preview</a>
+          <%= if config.package do %>
+            <a href="https://hex.pm/packages/<%= config.package %>/<%= config.version %>" class="footer-hex-package">Hex Package</a>
+          <% end %>
 
-            <%= source_path = node && Map.get(node, :source_path); if source_path do %>
-              (<a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>/show/<%= source_path %>">current file</a>)
+          <%
+            hex_url = get_hex_url(config, node && (Map.get(node, :source_path) || Map.get(node, :moduledoc_file)))
+            source_url = node && node.source_url
+          %>
+          <%= if hex_url || source_url do %>
+            View Code:
+            <%= if source_url do %>
+              <a href="<%= source_url %>" title="View Source Code" class="footer-button">Source Repo</a>
             <% end %>
-          </span>
-        <% end %>
 
-        <span class="line">
-          <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
-            Search HexDocs
-          </button>
+            <%= if hex_url do %>
+              <a href="<%= hex_url %>" class="footer-button">Hex Preview</a>
+            <% end %>
+          <% end %>
 
-          <%= if "epub" in config.formatters do %>
-            <a href="<%= config.project %>.epub" title="ePub version">
-              Download ePub version
+          <%= if "markdown" in config.formatters do %>
+            <a href="./markdown/<%= get_markdown_path(node) %>.md" title="Markdown version" class="footer-button">
+              View Markdown version
             </a>
           <% end %>
 
-          <%= if "markdown" in config.formatters do %>
-            <a href="<%= config.project %>-markdown.zip" title="Markdown version">
-              Download Markdown version
+          <%= if config.package do %>
+            <a href="https://repo.hex.pm/docs/<%= config.package %>-<%= config.version %>.tar.gz" title="Archive containing docs in all available formats" class="footer-button">
+              Download docs archive
             </a>
           <% end %>
+
+
+          <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
+            Search HexDocs
+          </button>
+
         </span>
       </p>
 

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

@@ -9,13 +9,6 @@
         <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>

lib/ex_doc/formatter/markdown.ex

@@ -32,18 +32,12 @@ defmodule ExDoc.Formatter.MARKDOWN do
 
     config = %{config | extras: extras}
 
-    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)
 
-    # 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
+    config.output |> Path.join("index.md") |> Path.relative_to_cwd()
   end
 
   defp normalize_config(config) do
@@ -58,7 +52,7 @@ defmodule ExDoc.Formatter.MARKDOWN do
   defp normalize_output(output) do
     output
     |> String.replace(~r/\r\n|\r|\n/, "\n")
-    |> String.replace(~r/\n{3,}/, "\n\n") 
+    |> String.replace(~r/\n{3,}/, "\n\n")
   end
 
   defp generate_nav(config, nodes) do
@@ -67,8 +61,10 @@ defmodule ExDoc.Formatter.MARKDOWN do
         modules |> Enum.chunk_by(& &1.group) |> Enum.map(&{hd(&1).group, &1})
       end)
 
-    content = Templates.nav_template(config, nodes)
-    |> normalize_output()
+    content =
+      Templates.nav_template(config, nodes)
+      |> normalize_output()
+
     File.write("#{config.output}/index.md", content)
   end
 
@@ -86,25 +82,12 @@ defmodule ExDoc.Formatter.MARKDOWN do
     end
   end
 
-
   defp generate_list(config, nodes) do
     nodes
     |> Task.async_stream(&generate_module_page(&1, config), timeout: :infinity)
     |> Enum.map(&elem(&1, 1))
   end
 
-  defp generate_zip(output) do
-    :zip.create(
-      String.to_charlist("#{output}-markdown.zip"),
-      files_to_add(output),
-      compress: [
-        ~c".md",
-        ~c".jpg",
-        ~c".png"
-      ]
-    )
-  end
-
   ## Helpers
 
   defp files_to_add(path) do
@@ -120,9 +103,10 @@ defmodule ExDoc.Formatter.MARKDOWN do
   end
 
   defp generate_module_page(module_node, config) do
-    content = Templates.module_page(config, module_node)
-    |> normalize_output()
+    content =
+      Templates.module_page(config, module_node)
+      |> normalize_output()
+
     File.write("#{config.output}/#{module_node.id}.md", content)
   end
-
 end

lib/ex_doc/formatter/markdown/templates.ex

@@ -16,14 +16,21 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
     module_template(config, module_node, summary)
   end
 
+  @doc """
+  Returns the formatted title for the module page.
+  """
+  def module_type(%{type: :task}), do: ""
+  def module_type(%{type: :module}), do: ""
+  def module_type(%{type: type}), do: "(#{type})"
+
   @doc """
   Generated ID for static file
   """
   def static_file_to_id(static_file) do
     static_file |> Path.basename() |> text_to_id()
   end
 
-  def node_doc(%{source_doc: %{"en"=> source}}), do: source
+  def node_doc(%{source_doc: %{"en" => source}}), do: source
   def node_doc(%{rendered_doc: source}), do: source
 
   @doc """
@@ -49,8 +56,8 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
     # it is simpler to guarantee they won't be duplicated in docs.
     Regex.replace(~r|(<[^>]*) id="[^"]*"([^>]*>)|, doc, ~S"\1\2", [])
   end
-  
-    @doc """
+
+  @doc """
   Add link headings for the given `content`.
 
   IDs are prefixed with `prefix`.
@@ -131,7 +138,6 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
     trim: true
   )
 
-
   EEx.function_from_file(
     :defp,
     :nav_item_template,
@@ -156,7 +162,6 @@ defmodule ExDoc.Formatter.MARKDOWN.Templates do
   #   trim: true
   # )
 
-
   # def media_type(_arg), do: nil
 
   templates = [

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

@@ -12,9 +12,9 @@
 > This <%= node.type %> is deprecated. <%= h(deprecated) %>.
 <% end %>
 
-<%= if specs = H.get_specs(node) do %>
-<%= for spec <- specs do %>
-> <%= H.format_spec_attribute(module, node) %> <%= spec %>
+<%= if node.specs != [] do %>
+<%= for spec <- node.specs do %>
+> <%= H.format_spec_attribute(module, node) %>: <%= spec %>
 <% end %>
 <% end %>
 

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

@@ -1,4 +1,4 @@
-# <%= module.title %> <%= H.module_type(module) %>
+# <%= module.title %> <%= module_type(module) %>
 
 <%= if deprecated = module.deprecated do %>
 > This <%= module.type %> is deprecated. <%=h deprecated %>.

lib/ex_doc/language/elixir.ex

@@ -289,7 +289,7 @@ defmodule ExDoc.Language.Elixir do
         {:local, :..}
 
       ["//", "", ""] ->
-        {:local, :"..//"}
+        {:local, :..//}
 
       ["", ""] ->
         {:local, :.}

test/ex_doc/formatter/markdown/templates_test.exs

@@ -38,39 +38,6 @@ defmodule ExDoc.Formatter.MARKDOWN.TemplatesTest do
     :ok
   end
 
-  describe "content_template/5" do
-    test "includes logo as a resource if specified in the config" do
-      nodes = %{modules: [], tasks: []}
-
-      content =
-        [logo: "my_logo.png"]
-        |> doc_config()
-        |> Templates.content_template(nodes, "uuid", "datetime", _static_files = [])
-
-      assert content =~ ~S|<item id="logo" href="assets/logo.png" media-type="image/png"/>|
-    end
-
-
-    test "includes modules as a resource" do
-      module_node = %ExDoc.ModuleNode{
-        module: XPTOModule,
-        doc: nil,
-        id: "XPTOModule",
-        title: "XPTOModule"
-      }
-
-      nodes = %{modules: [module_node], tasks: []}
-
-      content =
-        Templates.content_template(doc_config(), nodes, "uuid", "datetime", _static_files = [])
-
-      assert content =~
-               ~S|<item id="XPTOModule" href="XPTOModule.md" media-type="application/md+xml" properties="scripted"/>|
-
-      assert content =~ ~S|<itemref idref="XPTOModule"/>|
-    end
-  end
-
   describe "module_page/2" do
     test "generates only the module name when there's no more info" do
       module_node = %ExDoc.ModuleNode{
@@ -99,11 +66,11 @@ defmodule ExDoc.Formatter.MARKDOWN.TemplatesTest do
                ~r{### .*Example H3 heading.*}ms
 
       assert content =~
-               ~r{moduledoc.*Example.*<samp class="nc">CompiledWithDocs</samp><samp class="o">\.</samp><samp class="n">example</samp>.*}ms
+               ~r{moduledoc.*Example.*CompiledWithDocs\.example.*}ms
 
-      assert content =~ ~r{example/2.*Some example}ms
-      assert content =~ ~r{example_without_docs/0.*}ms
-      assert content =~ ~r{example_1/0.*> \(macro\)}ms
+      assert content =~ ~r{Some example}ms
+      assert content =~ ~r{example_without_docs().*}ms
+      assert content =~ ~r{example_1().*> \(macro\)}ms
 
       assert content =~ ~s{example(foo, bar \\\\ Baz)}
     end
@@ -121,21 +88,20 @@ defmodule ExDoc.Formatter.MARKDOWN.TemplatesTest do
       assert content =~ ~r{.*Legacy}ms
     end
 
-
     ## BEHAVIOURS
 
     test "outputs behavior and callbacks" do
       content = get_module_page([CustomBehaviourOne])
 
       assert content =~
-               ~r{# \s*CustomBehaviourOne\s*behaviour\s*}m
+               ~r{# CustomBehaviourOne \(behaviour\)}m
 
       assert content =~ ~r{Callbacks}
 
       content = get_module_page([CustomBehaviourTwo])
 
       assert content =~
-               ~r{# \s*CustomBehaviourTwo\s*behaviour\s*}m
+               ~r{# CustomBehaviourTwo \(behaviour\)}m
 
       assert content =~ ~r{Callbacks}
     end
@@ -144,14 +110,14 @@ defmodule ExDoc.Formatter.MARKDOWN.TemplatesTest do
 
     test "outputs the protocol type" do
       content = get_module_page([CustomProtocol])
-      assert content =~ ~r{# \s*CustomProtocol\s*protocol\s*}m
+      assert content =~ ~r{# CustomProtocol \(protocol\)}m
     end
 
     ## TASKS
 
     test "outputs the task type" do
       content = get_module_page([Mix.Tasks.TaskWithDocs])
-      assert content =~ ~r{# \s*mix task_with_docs\s*}m
+      assert content =~ ~r{#\s*mix task_with_docs}m
     end
   end
 end