Skip to content

Commit 5f4f6cf

Browse files
GuillaumeGomezJoshua Nelson
GuillaumeGomez
authored and
Joshua Nelson
committed
Convert documentation tab into button
1 parent 2106af4 commit 5f4f6cf

File tree

4 files changed

+243
-208
lines changed

4 files changed

+243
-208
lines changed

‎templates/about-base.html

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,34 @@
11
{% extends "base.html" %}
22

33
{% block header %}
4-
<div class="cratesfyi-package-container">
4+
<div class="cratesfyi-package-container">
55
<div class="container">
6-
<h1 id="crate-title" class="no-description">Docs.rs documentation</h1>
7-
<div class="pure-menu pure-menu-horizontal">
8-
<ul class="pure-menu-list">
9-
{% set text = "info-circle" | fas(fw=true) %}
10-
{% set text = text ~ ' <span class="title">About</span>' %}
11-
{{ macros::active_link(expected="index", href="/about", text=text) }}
6+
<div class="description-container">
7+
<h1 id="crate-title" class="no-description">Docs.rs documentation</h1>
8+
<div class="pure-menu pure-menu-horizontal">
9+
<ul class="pure-menu-list">
10+
{% set text = "info-circle" | fas(fw=true) %}
11+
{% set text = text ~ ' <span class="title">About</span>' %}
12+
{{ macros::active_link(expected="index", href="/about", text=text) }}
1213

13-
{% set text = "fonticons" | fab(fw=true) %}
14-
{% set text = text ~ ' <span class="title">Badges</span>' %}
15-
{{ macros::active_link(expected="badges", href="/about/badges", text=text) }}
14+
{% set text = "fonticons" | fab(fw=true) %}
15+
{% set text = text ~ ' <span class="title">Badges</span>' %}
16+
{{ macros::active_link(expected="badges", href="/about/badges", text=text) }}
1617

17-
{% set text = "cogs" | fas(fw=true) %}
18-
{% set text = text ~ ' <span class="title">Builds</span>' %}
19-
{{ macros::active_link(expected="builds", href="/about/builds", text=text) }}
18+
{% set text = "cogs" | fas(fw=true) %}
19+
{% set text = text ~ ' <span class="title">Builds</span>' %}
20+
{{ macros::active_link(expected="builds", href="/about/builds", text=text) }}
2021

21-
{% set text = "table" | fas(fw=true) %}
22-
{% set text = text ~ ' <span class="title">Metadata</span>' %}
23-
{{ macros::active_link(expected="metadata", href="/about/metadata", text=text) }}
22+
{% set text = "table" | fas(fw=true) %}
23+
{% set text = text ~ ' <span class="title">Metadata</span>' %}
24+
{{ macros::active_link(expected="metadata", href="/about/metadata", text=text) }}
2425

25-
{% set text = "road" | fas(fw=true) %}
26-
{% set text = text ~ ' <span class="title">Shorthand URLs</span>' %}
27-
{{ macros::active_link(expected="redirections", href="/about/redirections", text=text) }}
28-
</ul>
26+
{% set text = "road" | fas(fw=true) %}
27+
{% set text = text ~ ' <span class="title">Shorthand URLs</span>' %}
28+
{{ macros::active_link(expected="redirections", href="/about/redirections", text=text) }}
29+
</ul>
30+
</div>
2931
</div>
3032
</div>
31-
</div>
33+
</div>
3234
{% endblock %}

‎templates/header/package_navigation.html

Lines changed: 70 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -15,85 +15,85 @@
1515
{% macro package_navigation(title=false, metadata, platforms=false, active_tab) %}
1616
<div class="cratesfyi-package-container">
1717
<div class="container">
18-
{# Page title #}
19-
<h1 id="crate-title">
20-
{%- if title -%}
21-
{{ title }}
22-
{%- else -%}
23-
{{ metadata.name }} {{ metadata.version }}
24-
{{ "copy" | far(id="clipboard", aria_label="Copy crate name and version information", fa=true) }}
25-
{%- endif -%}
26-
</h1>
18+
<div class="description-container">
19+
{# The partial path of the crate, `:name/:release` #}
20+
{%- set crate_path = metadata.name ~ "/" ~ metadata.version -%}
2721

28-
{# Page description #}
29-
<div class="description">
30-
{%- if metadata.description -%}
31-
{{ metadata.description }}
32-
{%- endif -%}
33-
</div>
22+
{# If docs are built, show a button for them #}
3423

35-
<div class="pure-menu pure-menu-horizontal">
36-
{# If there are platforms, show a dropdown with them #}
37-
{%- if platforms -%}
38-
<ul class="pure-menu-list platforms-menu">
39-
<li class="pure-menu-item pure-menu-has-children pure-menu-allow-hover">
40-
<a href="#" class="pure-menu-link">Platform</a>
41-
<ul class="pure-menu-children">
42-
{%- for platform in platforms -%}
43-
<li class="pure-menu-item">
44-
<a href="/{{ metadata.name }}/{{ metadata.version }}/{{ platform }}/{{ metadata.target_name }}/"
45-
class="pure-menu-link">
46-
{{ platform }}
47-
</a>
48-
</li>
49-
{%- endfor -%}
50-
</ul>
51-
</li>
52-
</ul>
53-
{%- endif -%}
24+
{# Page title #}
25+
<h1 id="crate-title">
26+
{%- if title -%}
27+
{{ title }}
28+
{%- else -%}
29+
{{ metadata.name }} {{ metadata.version }}
30+
{{ "copy" | far(id="clipboard", aria_label="Copy crate name and version information", fa=true) }}
31+
{%- endif -%}
32+
</h1>
33+
34+
{# Page description #}
35+
<div class="description">
36+
{%- if metadata.description -%}
37+
{{ metadata.description }}
38+
{%- endif -%}
39+
</div>
5440

55-
<ul class="pure-menu-list">
56-
{# The partial path of the crate, `:name/:release` #}
57-
{%- set crate_path = metadata.name ~ "/" ~ metadata.version -%}
5841

59-
{# If docs are built, show a tab for them #}
60-
{%- if metadata.rustdoc_status -%}
61-
<li class="pure-menu-item">
62-
{# The docs tab redirects to the docs, so the tab will never be selected and seen #}
63-
<a href="/{{ crate_path | safe }}/{{ metadata.target_name }}/" class="pure-menu-link">
64-
{{ "book" | fas(fw=true) }}
65-
<span class="title"> Documentation</span>
66-
</a>
67-
</li>
42+
<div class="pure-menu pure-menu-horizontal">
43+
{# If there are platforms, show a dropdown with them #}
44+
{%- if platforms -%}
45+
<ul class="pure-menu-list platforms-menu">
46+
<li class="pure-menu-item pure-menu-has-children pure-menu-allow-hover">
47+
<a href="#" class="pure-menu-link">Platform</a>
48+
<ul class="pure-menu-children">
49+
{%- for platform in platforms -%}
50+
<li class="pure-menu-item">
51+
<a href="/{{ metadata.name }}/{{ metadata.version }}/{{ platform }}/{{ metadata.target_name }}/"
52+
class="pure-menu-link">
53+
{{ platform }}
54+
</a>
55+
</li>
56+
{%- endfor -%}
57+
</ul>
58+
</li>
59+
</ul>
6860
{%- endif -%}
6961

70-
{# The crate information tab #}
71-
<li class="pure-menu-item"><a href="/crate/{{ crate_path | safe }}"
72-
class="pure-menu-link{% if active_tab == 'crate' %} pure-menu-active{% endif %}">
73-
{{ "cube" | fas(fw=true) }}
74-
<span class="title"> Crate</span>
75-
</a>
76-
</li>
62+
<ul class="pure-menu-list">
63+
{# The crate information tab #}
64+
<li class="pure-menu-item"><a href="/crate/{{ crate_path | safe }}"
65+
class="pure-menu-link{% if active_tab == 'crate' %} pure-menu-active{% endif %}">
66+
{{ "cube" | fas(fw=true) }}
67+
<span class="title"> Crate</span>
68+
</a>
69+
</li>
7770

78-
{# The source view tab #}
79-
<li class="pure-menu-item">
80-
<a href="/crate/{{ crate_path | safe }}/source/"
81-
class="pure-menu-link{% if active_tab == 'source' %} pure-menu-active{% endif %}">
82-
{{ "folder-open" | far(fw=true) }}
83-
<span class="title"> Source</span>
84-
</a>
85-
</li>
71+
{# The source view tab #}
72+
<li class="pure-menu-item">
73+
<a href="/crate/{{ crate_path | safe }}/source/"
74+
class="pure-menu-link{% if active_tab == 'source' %} pure-menu-active{% endif %}">
75+
{{ "folder-open" | far(fw=true) }}
76+
<span class="title"> Source</span>
77+
</a>
78+
</li>
8679

87-
{# The builds tab #}
88-
<li class="pure-menu-item">
89-
<a href="/crate/{{ crate_path | safe }}/builds"
90-
class="pure-menu-link{% if active_tab == 'builds' %} pure-menu-active{% endif %}">
91-
{{ "cogs" | fas }}
92-
<span class="title"> Builds</span>
93-
</a>
94-
</li>
95-
</ul>
80+
{# The builds tab #}
81+
<li class="pure-menu-item">
82+
<a href="/crate/{{ crate_path | safe }}/builds"
83+
class="pure-menu-link{% if active_tab == 'builds' %} pure-menu-active{% endif %}">
84+
{{ "cogs" | fas }}
85+
<span class="title"> Builds</span>
86+
</a>
87+
</li>
88+
</ul>
89+
</div>
9690
</div>
91+
92+
{%- if metadata.rustdoc_status -%}
93+
<a href="/{{ crate_path | safe }}/{{ metadata.target_name }}/" class="doc-link">
94+
{{ "book" | fas(fw=true) }} Documentation
95+
</a>
96+
{%- endif -%}
9797
</div>
9898
</div>
9999
{% endmacro package_navigation %}

‎templates/releases/header.html

Lines changed: 56 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -15,69 +15,71 @@
1515
{% macro header(title, description, tab, author=false) %}
1616
<div class="cratesfyi-package-container">
1717
<div class="container">
18-
<h1 id="crate-title">{{ title }}</h1>
19-
<div class="description">{{ description | default(value="") }}</div>
18+
<div class="description-container">
19+
<h1 id="crate-title">{{ title }}</h1>
20+
<div class="description">{{ description | default(value="") }}</div>
2021

21-
{# This does double-duty as the search, so hide all tabs when we're searching something #}
22-
{%- if tab != "search" -%}
23-
<div class="pure-menu pure-menu-horizontal">
24-
<ul class="pure-menu-list">
25-
<li class="pure-menu-item">
26-
<a href="/releases" class="pure-menu-link{% if tab == 'recent' %} pure-menu-active{% endif %}">
27-
{{ "leaf" | fas(fw=true) }}
28-
<span class="title">Recent</span>
29-
</a>
30-
</li>
31-
32-
<li class="pure-menu-item">
33-
<a href="/releases/stars" class="pure-menu-link{% if tab == 'stars' %} pure-menu-active{% endif %}">
34-
{{ "star" | fas(fw=true) }}
35-
<span class="title">Stars</span>
36-
</a>
37-
</li>
22+
{# This does double-duty as the search, so hide all tabs when we're searching something #}
23+
{%- if tab != "search" -%}
24+
<div class="pure-menu pure-menu-horizontal">
25+
<ul class="pure-menu-list">
26+
<li class="pure-menu-item">
27+
<a href="/releases" class="pure-menu-link{% if tab == 'recent' %} pure-menu-active{% endif %}">
28+
{{ "leaf" | fas(fw=true) }}
29+
<span class="title">Recent</span>
30+
</a>
31+
</li>
3832

39-
<li class="pure-menu-item">
40-
<a href="/releases/recent-failures"
41-
class="pure-menu-link{% if tab == 'recent-failures' %} pure-menu-active{% endif %}">
42-
{{ "exclamation-triangle" | fas(fw=true) }}
43-
<span class="title">Recent Failures</span>
44-
</a>
45-
</li>
33+
<li class="pure-menu-item">
34+
<a href="/releases/stars" class="pure-menu-link{% if tab == 'stars' %} pure-menu-active{% endif %}">
35+
{{ "star" | fas(fw=true) }}
36+
<span class="title">Stars</span>
37+
</a>
38+
</li>
4639

47-
<li class="pure-menu-item">
48-
<a href="/releases/failures"
49-
class="pure-menu-link{% if tab == 'failures' %} pure-menu-active{% endif %}">
50-
{{ "star" | far(fw=true) }}
51-
<span class="title">Failures By Stars</span>
52-
</a>
53-
</li>
40+
<li class="pure-menu-item">
41+
<a href="/releases/recent-failures"
42+
class="pure-menu-link{% if tab == 'recent-failures' %} pure-menu-active{% endif %}">
43+
{{ "exclamation-triangle" | fas(fw=true) }}
44+
<span class="title">Recent Failures</span>
45+
</a>
46+
</li>
5447

55-
<li class="pure-menu-item">
56-
<a href="/releases/activity"
57-
class="pure-menu-link{% if tab == 'activity' %} pure-menu-active{% endif %}">
58-
{{ "chart-line" | fas(fw=true) }}
59-
<span class="title">Activity</span>
60-
</a>
61-
</li>
48+
<li class="pure-menu-item">
49+
<a href="/releases/failures"
50+
class="pure-menu-link{% if tab == 'failures' %} pure-menu-active{% endif %}">
51+
{{ "star" | far(fw=true) }}
52+
<span class="title">Failures By Stars</span>
53+
</a>
54+
</li>
6255

63-
<li class="pure-menu-item">
64-
<a href="/releases/queue" class="pure-menu-link{% if tab == 'queue' %} pure-menu-active{% endif %}">
65-
{{ "list" | fas(fw=true) }}
66-
<span class="title">Queue</span>
67-
</a>
68-
</li>
56+
<li class="pure-menu-item">
57+
<a href="/releases/activity"
58+
class="pure-menu-link{% if tab == 'activity' %} pure-menu-active{% endif %}">
59+
{{ "chart-line" | fas(fw=true) }}
60+
<span class="title">Activity</span>
61+
</a>
62+
</li>
6963

70-
{%- if author -%}
7164
<li class="pure-menu-item">
72-
<a href="#" class="pure-menu-link{% if tab == 'author' %} pure-menu-active{% endif %}">
73-
{{ "user" | fas(fw=true) }}
74-
<span class="title">{{ author }}</span>
65+
<a href="/releases/queue" class="pure-menu-link{% if tab == 'queue' %} pure-menu-active{% endif %}">
66+
{{ "list" | fas(fw=true) }}
67+
<span class="title">Queue</span>
7568
</a>
7669
</li>
77-
{%- endif -%}
78-
</ul>
79-
</div>
80-
{%- endif -%}
70+
71+
{%- if author -%}
72+
<li class="pure-menu-item">
73+
<a href="#" class="pure-menu-link{% if tab == 'author' %} pure-menu-active{% endif %}">
74+
{{ "user" | fas(fw=true) }}
75+
<span class="title">{{ author }}</span>
76+
</a>
77+
</li>
78+
{%- endif -%}
79+
</ul>
80+
</div>
81+
{%- endif -%}
82+
</div>
8183
</div>
8284
</div>
8385
{% endmacro header %}

0 commit comments

Comments
 (0)