docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

display reading time and tags in toc nav 

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2022-11-07 15:19:14 +01:00
parent a9b0774946
commit 6d431bde49
No known key found for this signature in database
GPG Key ID: 3248E46B6BB8C7F7
3 changed files with 60 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
_includes/read_time.html
View File

@ -1,6 +0,0 @@
{%- unless page.skip_read_time == true -%}
{%- assign words = content | number_of_words -%}
{%- if words >= 360 -%}
<em class="reading-time">Estimated reading time: {{ words | divided_by:180 }} minutes</em>
{%- endif -%}
{%- endunless -%}

51
_layouts/docs.html
View File

@ -28,20 +28,8 @@
{%- if page.advisory -%}
<blockquote>{{ site.data.advisories.texts[page.advisory] | markdownify }}</blockquote>
{%- endif -%}
<p>{%- include read_time.html -%}</p>
<p></p>
{{ content }}
{%- unless page.notags == true -%}
{%- assign keywords = page.keywords | split:"," -%}
{%- if keywords.size > 0 -%}
<span class="glyphicon glyphicon-tags" style="padding-right: 10px"></span><span style="vertical-align: 2px">
{%- for keyword in keywords -%}
{%- assign strippedKeyword = keyword | strip -%}
<a href="/search/?q={{ strippedKeyword }}">{{ strippedKeyword }}</a>
{%- unless forloop.last %}, {% endunless -%}
{%- endfor -%}
</span>
{%- endif -%}
{%- endunless %}
</section>
</main>
<nav class="col-nav">
@ -64,18 +52,35 @@
{%- assign my_min = page.toc_min | default: site.toc_min | default: 2 -%}
{%- assign my_max = page.toc_max | default: site.toc_max | default: 3 -%}
{%- assign my_name = page.url | default: "unnamed" -%}
<div id="side-toc-title">Contents:</div>
<div class="side-toc-title">Page details</div>
<div class="metadata-items">
<ul>
{%- unless page.skip_read_time == true %}{% assign words = content | number_of_words %}{% if words >= 360 -%}
<li title="Estimated reading time"><i class="fa fa-clock" aria-hidden="true"></i> {{ words | divided_by:180 }} minutes read</span></li>
{%- endif %}{% endunless -%}
{%- if edit_url != "" -%}
<li><a href="{{ edit_url }}"><i class="fa fa-pencil" aria-hidden="true"></i> Edit this page</a></li>
{%- endif -%}
{%- if issue_url != "" -%}
<li><a href="{{ issue_url }}" class="nomunge"><i class="fa fa-check" aria-hidden="true"></i> Request changes</a></li>
{%- endif -%}
</ul>
</div>
{%- unless page.notags == true -%}
{%- assign keywords = page.keywords | split:"," -%}
{%- if keywords.size > 0 -%}
<div class="side-toc-title">Tags</div>
<div class="keywords-items">
{%- for keyword in keywords -%}
{%- assign strippedKeyword = keyword | strip -%}
<a href="/search/?q={{ strippedKeyword }}" class="nomunge"><i class="fa fa-tag" aria-hidden="true"></i> {{ strippedKeyword }}</a>
{%- endfor -%}
</div>
{%- endif -%}
{%- endunless %}
<div class="side-toc-title">Contents</div>
{%- include toc_pure_liquid.html html=content sanitize=true class="inline_toc" id="my_toc" toc_min=my_min toc_max=my_max page_name=my_name -%}
{%- endunless -%}
<div class="feedback-links">
<ul>
{%- if edit_url != "" -%}
<li><a href="{{ edit_url }}"><i class="fa fa-pencil" aria-hidden="true"></i> Edit this page</a></li>
{%- endif -%}
{%- if issue_url != "" -%}
<li><a href="{{ issue_url }}" class="nomunge"><i class="fa fa-check" aria-hidden="true"></i> Request changes</a></li>
{%- endif -%}
</ul>
</div>
</div>
</div>

38
_scss/_navigation.scss
View File

@ -163,7 +163,7 @@
color: #677285;
}
div#side-toc-title {
div.side-toc-title {
font-size: 12px;
font-weight: bold;
margin: 11px 0 10px 13px;
@ -281,12 +281,38 @@ input:checked+.slider:before {
}
}
/*
* feedback links **************************************************************
*/
div.feedback-links {
margin: 15px 0 10px 0;
}
.feedback-links {
margin: 15px 0 10px 0;
div.metadata-items {
margin: 15px 0 10px 0;
ul {
list-style: none;
margin: 0;
padding-left: 20px;
line-height: 20px;
li {
padding: 2px 8px 2px 0;
width: 100%;
font-size: 12px;
a {
padding: 0;
}
}
}
}
div.keywords-items {
padding-left: 20px;
font-size: 12px;
a {
display: inline-block;
margin-right: 8px;
i.fa {
margin: 0;
}
}
}
/*