Do not add fancy anchors around verbatim headers, closes #2128

Author: josevalim

lib/ex_doc/formatter/html/templates.ex

@@ -193,7 +193,8 @@ defmodule ExDoc.Formatter.HTML.Templates do
 
   defp add_fancy_anchors(ast) do
     ExDoc.DocAST.map_tags(ast, fn
-      {tag, attrs, inner, meta} = ast when tag in [:h2, :h3] ->
+      {tag, attrs, inner, meta} = ast
+      when tag in [:h2, :h3] and not is_map_key(meta, :verbatim) ->
         if id = Keyword.get(attrs, :id) do
           attrs =
             Keyword.update(

test/ex_doc/formatter/html/templates_test.exs

@@ -42,15 +42,19 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
   end
 
   describe "render_doc" do
+    defp render_doc(doc) do
+      doc
+      |> ExDoc.DocAST.parse!("text/markdown")
+      |> ExDoc.DocAST.add_ids_to_headers([:h2, :h3])
+      |> Templates.render_doc()
+    end
+
     test "adds fancy anchors around ids" do
-      assert """
+      assert render_doc("""
              ## Foo
 
              ### Bar {:class=wrap}
-             """
-             |> ExDoc.DocAST.parse!("text/markdown")
-             |> ExDoc.DocAST.add_ids_to_headers([:h2, :h3])
-             |> Templates.render_doc() ==
+             """) ==
                """
                <h2 id="foo" class="section-heading">
                  <a href="#foo" class="hover-link">
@@ -67,6 +71,12 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
                """
                |> String.replace(~r/\n\s*/, "")
     end
+
+    test "skips fancy anchors on verbatim" do
+      assert render_doc("""
+             <h2>Foo</h2>
+             """) == "<h2 id=\"foo\">Foo</h2>"
+    end
   end
 
   describe "sidebar" do