Add the option to trim down the footer

josevalim · josevalim · commit 94134e01c419 · 2025-12-09T17:14:34.000+01:00
diff --git a/lib/ex_doc/cli.ex b/lib/ex_doc/cli.ex
@@ -23,6 +23,7 @@ defmodule ExDoc.CLI do
           canonical: :string,
           config: :string,
           favicon: :string,
+          footer: :boolean,
           formatter: [:keep, :string],
           homepage_url: :string,
           language: :string,
@@ -200,6 +201,7 @@ defmodule ExDoc.CLI do
           --favicon             Path to a favicon image for the project. Must be PNG, JPEG or SVG. The image
                                 will be placed in the output "assets" directory.
       -f, --formatter           Docs formatter to use (html or epub), default: html and epub
+          --no-footer           Do not render the footer (except for the required "Built with ExDoc" note)
           --homepage-url        URL to link to for the site name
           --language            Identify the primary language of the documents, its value must be
                                 a valid [BCP 47](https://tools.ietf.org/html/bcp47) language tag, default: "en"
diff --git a/lib/ex_doc/config.ex b/lib/ex_doc/config.ex
@@ -29,6 +29,7 @@ defmodule ExDoc.Config do
             extras: [],
             favicon: nil,
             filter_modules: &__MODULE__.filter_modules/2,
+            footer: true,
             formatter: "html",
             formatters: [],
             group_for_doc: &__MODULE__.default_group_for_doc/1,
diff --git a/lib/ex_doc/formatter/html/templates/footer_template.eex b/lib/ex_doc/formatter/html/templates/footer_template.eex
@@ -1,39 +1,47 @@
     <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>
+      <%= if config.footer do %>
+        <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>
+
+              <a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>">Hex Preview</a>
+
+              <%= if source_path do %>
+                (<a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>/show/<%= source_path %>">current file</a>)
+              <% end %>
+            </span>
+          <% end %>
 
-            <a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>">Hex Preview</a>
+          <span class="line">
+            <button class="a-main footer-button display-quick-switch" title="Go to package docs">
+              Go to package docs
+            </button>
 
-            <%= if source_path do %>
-              (<a href="https://preview.hex.pm/preview/<%= config.package %>/<%= config.version %>/show/<%= source_path %>">current file</a>)
+            <%= if "epub" in config.formatters do %>
+              <a href="<%= config.project %>.epub" title="ePub version">
+                Download ePub version
+              </a>
             <% end %>
           </span>
-        <% end %>
-
-        <span class="line">
-          <button class="a-main footer-button display-quick-switch" title="Go to package docs">
-            Go to package docs
-          </button>
+        </p>
 
-          <%= if "epub" in config.formatters do %>
-            <a href="<%= config.project %>.epub" title="ePub version">
-              Download ePub version
-            </a>
+        <p class="built-using">
+          Built using
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v<%= ExDoc.version() %>) for the
+          <%= if config.proglang == :erlang do %>
+            <a href="https://erlang.org" title="Erlang" target="_blank" translate="no">Erlang programming language</a>
+          <% else %>
+            <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
           <% end %>
-        </span>
-      </p>
+        </p>
+      <% else %>
+        <p class="built-using">
+          Built using
+          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v<%= ExDoc.version() %>)
+        </p>
+      <% end %>
 
-      <p class="built-using">
-        Built using
-        <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v<%= ExDoc.version() %>) for the
-        <%= if config.proglang == :erlang do %>
-          <a href="https://erlang.org" title="Erlang" target="_blank" translate="no">Erlang programming language</a>
-        <% else %>
-          <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
-        <% end %>
-      </p>
       <%= before_closing_footer_tag(config, :html) %>
     </footer>
   </div>
diff --git a/lib/mix/tasks/docs.ex b/lib/mix/tasks/docs.ex
@@ -132,14 +132,17 @@ defmodule Mix.Tasks.Docs do
 
     * `:formatters` - Formatter to use; default: ["html", "epub"], options: "html", "epub".
 
+    * `:footer` - When false, does not render the footer on all pages, except for
+      the required "Built with ExDoc" note.
+
     * `:groups_for_extras`, `:groups_for_modules`, `:groups_for_docs`, and `:default_group_for_doc` -
-      See the "Groups" section
+      See the "Groups" section.
 
     * `:ignore_apps` - Apps to be ignored when generating documentation in an umbrella project.
       Receives a list of atoms. Example: `[:first_app, :second_app]`.
 
     * `:language` - Identify the primary language of the documents, its value must be
-      a valid [BCP 47](https://tools.ietf.org/html/bcp47) language tag; default: "en"
+      a valid [BCP 47](https://tools.ietf.org/html/bcp47) language tag. Default: "en".
 
     * `:logo` - Path to a logo image file for the project. Must be PNG, JPEG or SVG. When
       specified, the image file will be placed in the output "assets" directory, named
@@ -148,23 +151,23 @@ defmodule Mix.Tasks.Docs do
       predictable sizing and cropping.
 
     * `:main` - Main page of the documentation. It may be a module or a
-      generated page, like "Plug" or "api-reference"; default: "api-reference".
+      generated page, like "Plug" or "api-reference". Default: "api-reference".
 
     * `:markdown_processor` - The markdown processor to use,
-      either `module()` or `{module(), keyword()}` to provide configuration options;
+      either `module()` or `{module(), keyword()}` to provide configuration options.
 
-    * `:meta` - A keyword list or a map to specify meta tag attributes
+    * `:meta` - A keyword list or a map to specify meta tag attributes.
 
-    * `:nest_modules_by_prefix` - See the "Nesting" section
+    * `:nest_modules_by_prefix` - See the "Nesting" section.
 
-    * `:output` - Output directory for the generated docs; default: "doc".
+    * `:output` - Output directory for the generated docs. Default: "doc".
       May be overridden by command line argument.
 
     * `:redirects` - A map or list of tuples, where the key is the path to redirect from and the
        value is the path to redirect to. The extension is omitted in both cases, i.e `%{"old-readme" => "readme"}`.
        See the "Changing documentation over time" section below for more.
 
-    * `:search` - A list of search engine configurations. See the "Search engines" section
+    * `:search` - A list of search engine configurations. See the "Search engines" section.
 
     * `:skip_undefined_reference_warnings_on` - ExDoc warns when it can't create a `Mod.fun/arity`
       reference in the current project docs (for example, because of a typo). This option controls when to
@@ -190,8 +193,8 @@ defmodule Mix.Tasks.Docs do
     * `:source_url` - The source URL fallback if `:source_url` is not given at the project
       configuration. See the following sections.
 
-    * `:source_ref` - The branch/commit/tag used for source link inference;
-      default: "main".
+    * `:source_ref` - The branch/commit/tag used for source link inference.
+      Default: "main".
 
     * `:source_url_pattern` - Public URL of the project for source links. This is derived
       automatically from the project's `:source_url` and `:source_ref` when using one of
diff --git a/test/ex_doc/formatter/html/templates_test.exs b/test/ex_doc/formatter/html/templates_test.exs
@@ -157,6 +157,9 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
 
       assert Templates.footer_template(doc_config(context, proglang: :elixir), nil) ==
                Templates.footer_template(doc_config(context), nil)
+
+      refute Templates.footer_template(doc_config(context, footer: false), nil) =~
+               "Elixir programming language"
     end
 
     test "includes api reference", context do
