Skip to content

Revert hover link approach to fix markup of headings containing links #1752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2023
Merged

Revert hover link approach to fix markup of headings containing links #1752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions assets/css/content/admonition.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@

.content-inner blockquote :is(h3, h4):is(.warning, .error, .info, .neutral, .tip) :is(a, a:visited) {
color: inherit;
text-decoration-color: currentColor;
}

@media screen and (max-width: 768px) {
Expand Down
16 changes: 11 additions & 5 deletions assets/css/content/general.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,23 +132,29 @@
}

.content-inner .section-heading a {
color: var(--links);
text-decoration: none;
color: var(--links);
display: inline-block;
}

.content-inner .section-heading a.no-underline {
color: var(--links);
}

.content-inner .section-heading a.hover-link {
text-decoration: none;
}

.content-inner .section-heading i {
font-size: 16px;
--icon-size: 16px;
--icon-spacing: 5px;
font-size: var(--icon-size);
margin-top: .1em;
margin-left: -21px;
margin-left: calc(-1 * (var(--icon-size) + var(--icon-spacing)));
padding-right: var(--icon-spacing);
opacity: 0;
}

.content-inner .section-heading a:is(:hover, :focus) i {
.content-inner .section-heading:hover i {
opacity: 1;
}

Expand Down
5 changes: 2 additions & 3 deletions lib/ex_doc/formatter/html/templates.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,10 +302,9 @@ defmodule ExDoc.Formatter.HTML.Templates do

"""
<#{tag} id="#{prefix}#{id}" class="#{class_attribute}">
<a href="##{prefix}#{id}">
<a href="##{prefix}#{id}" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
#{title}
</a>
</a>#{title}
</#{tag}>
"""
end
Expand Down
4 changes: 2 additions & 2 deletions test/ex_doc/formatter/epub/templates_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ defmodule ExDoc.Formatter.EPUB.TemplatesTest do
assert content =~ ~r{<h1 id="content">\s*CompiledWithDocs\s*}

assert content =~
~r{<h2 id="module-example-unicode-escaping" class="section-heading">.*<a href="#module-example-unicode-escaping">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example.*</a>.*</h2>}ms
~r{<h2 id="module-example-unicode-escaping" class="section-heading">.*<a href="#module-example-unicode-escaping" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*Example.*</h2>}ms

assert content =~
~r{<h3 id="module-example-h3-heading" class="section-heading">.*<a href="#module-example-h3-heading">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example H3 heading.*</a>.*</h3>}ms
~r{<h3 id="module-example-h3-heading" class="section-heading">.*<a href="#module-example-h3-heading" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*Example H3 heading.*</h3>}ms

assert content =~
~r{moduledoc.*Example.*<samp class="nc">CompiledWithDocs</samp><samp class="o">\.</samp><samp class="n">example</samp>.*}ms
Expand Down
66 changes: 27 additions & 39 deletions test/ex_doc/formatter/html/templates_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,101 +47,90 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
test "generates headers with hovers" do
assert Templates.link_headings("<h2>Foo</h2><h2>Bar</h2>") == """
<h2 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h2>
<h2 id="bar" class="section-heading">
<a href="#bar">
<a href="#bar" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Bar
</a>
</a>Bar
</h2>
"""

assert Templates.link_headings("<h2>Foo</h2>\n<h2>Bar</h2>") == """
<h2 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h2>

<h2 id="bar" class="section-heading">
<a href="#bar">
<a href="#bar" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Bar
</a>
</a>Bar
</h2>
"""

assert Templates.link_headings("<h2></h2><h2>Bar</h2>") == """
<h2></h2><h2 id="bar" class="section-heading">
<a href="#bar">
<a href="#bar" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Bar
</a>
</a>Bar
</h2>
"""

assert Templates.link_headings("<h2></h2>\n<h2>Bar</h2>") == """
<h2></h2>
<h2 id="bar" class="section-heading">
<a href="#bar">
<a href="#bar" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Bar
</a>
</a>Bar
</h2>
"""

assert Templates.link_headings("<h2>Foo</h2><h2></h2>") ==
String.trim_trailing("""
<h2 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h2>
<h2></h2>
""")

assert Templates.link_headings("<h2>Foo</h2>\n<h2></h2>") ==
String.trim_trailing("""
<h2 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h2>

<h2></h2>
""")

assert Templates.link_headings("<h3>Foo</h3>") == """
<h3 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h3>
"""
end

test "generates headers with unique id's" do
assert Templates.link_headings("<h3>Foo</h3>\n<h3>Foo</h3>") == """
<h3 id="foo" class="section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h3>

<h3 id="foo-1" class="section-heading">
<a href="#foo-1">
<a href="#foo-1" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h3>
"""
end
Expand All @@ -153,10 +142,9 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do

assert Templates.link_headings(admonition_block) == """
<blockquote><h3 id="foo" class="warning section-heading">
<a href="#foo">
<a href="#foo" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
Foo
</a>
</a>Foo
</h3>
</blockquote>
"""
Expand Down Expand Up @@ -471,10 +459,10 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
~r{moduledoc.*Example.*<span class="nc">CompiledWithDocs</span><span class="o">\.</span><span class="n">example</span>.*}ms

assert content =~
~r{<h2 id="module-example-unicode-escaping" class="section-heading">.*<a href="#module-example-unicode-escaping">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example.*</a>.*</h2>}ms
~r{<h2 id="module-example-unicode-escaping" class="section-heading">.*<a href="#module-example-unicode-escaping" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*Example.*</h2>}ms

assert content =~
~r{<h3 id="module-example-h3-heading" class="section-heading">.*<a href="#module-example-h3-heading">.*<i class="ri-link-m" aria-hidden="true"></i>.*Example H3 heading.*</a>.*</h3>}ms
~r{<h3 id="module-example-h3-heading" class="section-heading">.*<a href="#module-example-h3-heading" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*Example H3 heading.*</h3>}ms

# Summaries
assert content =~ ~r{example/2.*Some example}ms
Expand Down Expand Up @@ -567,7 +555,7 @@ defmodule ExDoc.Formatter.HTML.TemplatesTest do
content = get_module_page([CompiledWithDocs], context)

assert content =~
~r{<h3 id="example_with_h3/0-examples" class="section-heading">.*<a href="#example_with_h3/0-examples">.*<i class="ri-link-m" aria-hidden="true"></i>.*Examples.*</a>.*</h3>}ms
~r{<h3 id="example_with_h3/0-examples" class="section-heading">.*<a href="#example_with_h3/0-examples" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*Examples.*</h3>}ms
end

test "do not output overlapping functions, causing duplicate IDs", context do
Expand Down
4 changes: 2 additions & 2 deletions test/ex_doc/formatter/html_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,10 +365,10 @@ defmodule ExDoc.Formatter.HTMLTest do
assert content =~ ~r{<title>README [^<]*</title>}

assert content =~
~r{<h2 id="header-sample" class="section-heading">.*<a href="#header-sample">.*<i class="ri-link-m" aria-hidden="true"></i>.*<code(\sclass="inline")?>Header</code> sample.*</a>.*</h2>}ms
~r{<h2 id="header-sample" class="section-heading">.*<a href="#header-sample" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*<code(\sclass="inline")?>Header</code> sample.*</h2>}ms

assert content =~
~r{<h2 id="more-than" class="section-heading">.*<a href="#more-than">.*<i class="ri-link-m" aria-hidden="true"></i>.*more &gt; than.*</a>.*</h2>}ms
~r{<h2 id="more-than" class="section-heading">.*<a href="#more-than" class="hover-link">.*<i class="ri-link-m" aria-hidden="true"></i>.*</a>.*more &gt; than.*</h2>}ms

assert content =~ ~r{<a href="RandomError.html"><code(\sclass="inline")?>RandomError</code>}

Expand Down