Extract title even with comments

elixir-lang · Aug 25, 2023 · c47807c · c47807c
1 parent 4628900
commit c47807c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/lib/ex_doc/doc_ast.ex b/lib/ex_doc/doc_ast.ex
@@ -104,13 +104,9 @@ defmodule ExDoc.DocAST do
   """
   def extract_title(ast)
 
-  def extract_title([{:h1, _attrs, inner, _meta} | ast]) do
-    {:ok, inner, ast}
-  end
-
-  def extract_title(_ast) do
-    :error
-  end
+  def extract_title([{:comment, _, _, _} | ast]), do: extract_title(ast)
+  def extract_title([{:h1, _attrs, inner, _meta} | ast]), do: {:ok, inner, ast}
+  def extract_title(_ast), do: :error
 
   @doc """
   Returns text content from the given AST.

diff --git a/test/ex_doc/formatter/html_test.exs b/test/ex_doc/formatter/html_test.exs
@@ -421,6 +421,8 @@ defmodule ExDoc.Formatter.HTMLTest do
 
       content = File.read!(tmp_dir <> "/html/livebookfile.html")
 
+      assert content =~ ~r{<span>Title for Livebook Files</span>\s*</h1>}
+
       assert content =~
                ~s{<a href="https://github.com/elixir-lang/elixir/blob/main/test/fixtures/LivebookFile.livemd#L1" title="View Source"}
 

diff --git a/test/fixtures/LivebookFile.livemd b/test/fixtures/LivebookFile.livemd
@@ -1,3 +1,5 @@
-# Livebook Files
+<!-- foobar -->
+
+# Title for Livebook Files
 
 Read `.livemd` files generated by [livebook](https://github.com/livebook-dev/livebook).