jekyll-rtd-theme 0.1.5 → 0.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -2
- data/_includes/{versions.liquid → addons.liquid} +2 -2
- data/_includes/addons/comments/disqus.liquid +10 -0
- data/_includes/breadcrumbs.liquid +5 -3
- data/_includes/extend/list.liquid +15 -0
- data/_includes/extend/tabs.liquid +2 -0
- data/_includes/{toctree_ln.liquid → extend/toctree.liquid} +1 -1
- data/_includes/footer.liquid +17 -10
- data/_includes/list.liquid +5 -1
- data/_includes/reset/variables.liquid +8 -6
- data/_includes/{toctree_l1.liquid → toctree.liquid} +1 -1
- data/_layouts/default.liquid +20 -7
- metadata +8 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7147e810bfa78250ce75f3dd42eb6de5ba2b92c09331572836840d660b34acec
|
|
4
|
+
data.tar.gz: 969ba7a43596ebcd755df47107fce7934fd2ace44609d0af9e7c6dd8dd745023
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 274f7cbe15c835a2f5194a71416937a1a4b4058f85030a51598198616503851cd500fa38084702cea1ce0b63c1bca39710c2c38441f32614f56c10f9be35b6f6
|
|
7
|
+
data.tar.gz: 6a5501806745641df092d10f8ed017809ba3aa1f732bfd49a94446e872944647663f7d1f478a363a6fcd7c1267ab9ab5a3c7ec675549955fb61439fdde54c876
|
data/README.md
CHANGED
|
@@ -9,12 +9,24 @@ Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_the
|
|
|
9
9
|
|
|
10
10
|
![][demo]
|
|
11
11
|
|
|
12
|
+
## Notable features
|
|
13
|
+
- Write documents directly, like docsify!
|
|
14
|
+
- Only need one file `_config.yml` to configure site
|
|
15
|
+
- Bundled as a "theme gem" for easier installation/upgrading.
|
|
16
|
+
- Compatible with GitHub Pages.
|
|
17
|
+
- Optimized for search engines with support for Open Graph data.
|
|
18
|
+
- Optimized for search engines with `robots.txt` and `sitemap.xml`.
|
|
19
|
+
- Search engine support
|
|
20
|
+
- Commenting support
|
|
21
|
+
- Google,Baidu,CNZZ Analytics support.
|
|
22
|
+
- UI localized text in English(default), Chinese(中文)
|
|
23
|
+
- And many features waiting for you to discover.
|
|
24
|
+
|
|
12
25
|
## Roadmap
|
|
13
26
|
See the [open issues][issues] for a list of proposed features (and known issues).
|
|
14
27
|
|
|
15
|
-
|
|
16
28
|
## Documents
|
|
17
|
-
For
|
|
29
|
+
For full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
|
|
18
30
|
|
|
19
31
|
## The License
|
|
20
32
|
The theme is available as open source under the terms of the [MIT License][license].
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
|
2
2
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
3
3
|
<span class="fa fa-book"> {{ site.title }}</span>
|
|
4
|
-
{{ commit }}
|
|
4
|
+
{% if site.addons_commit %}{{ commit }}{% endif %}
|
|
5
5
|
<span class="fa fa-caret-down"></span>
|
|
6
6
|
</span>
|
|
7
7
|
<div class="rst-other-versions">
|
|
8
|
-
{%- assign items = addons |
|
|
8
|
+
{%- assign items = site.addons | default: addons -%}
|
|
9
9
|
{% for item in items -%}
|
|
10
10
|
{% include addons/source/{{ item }}.liquid %}
|
|
11
11
|
{% endfor -%}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
{% if site.disqus %}
|
|
2
|
+
<div id="disqus_thread" class="articleComments"></div>
|
|
3
|
+
<script>
|
|
4
|
+
(function(script) {
|
|
5
|
+
script.src = "https://{{ site.disqus }}.disqus.com/embed.js";
|
|
6
|
+
script.setAttribute("data-timestamp", +new Date());
|
|
7
|
+
document.head.appendChild(script);
|
|
8
|
+
})(document.createElement("script"));
|
|
9
|
+
</script>
|
|
10
|
+
{% endif %}
|
|
@@ -27,9 +27,11 @@
|
|
|
27
27
|
{%- endif -%}
|
|
28
28
|
{%- endfor -%}
|
|
29
29
|
{%- endcase %}
|
|
30
|
-
|
|
31
|
-
<
|
|
32
|
-
|
|
30
|
+
{%- if site.edit -%}
|
|
31
|
+
<li class="wy-breadcrumbs-aside">
|
|
32
|
+
<a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
|
|
33
|
+
</li>
|
|
34
|
+
{%- endif -%}
|
|
33
35
|
</ul>
|
|
34
36
|
<hr>
|
|
35
37
|
</div>
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
{%- include reset/html.liquid -%}
|
|
2
|
+
{%- include reset/workspace.liquid -%}
|
|
3
|
+
|
|
4
|
+
{%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
|
|
5
|
+
{%- assign size = workspace_level | minus: base -%}
|
|
6
|
+
{%- assign size_p1 = size | plus: 1 -%}
|
|
7
|
+
|
|
8
|
+
{%- assign dir = html_pages | where: "url", workspace | first %}
|
|
9
|
+
{% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ site.baseurl | append: dir.url }})
|
|
10
|
+
|
|
11
|
+
{%- for item in workspace_files %}
|
|
12
|
+
{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
|
|
13
|
+
{%- endfor -%}
|
|
14
|
+
|
|
15
|
+
{%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}
|
|
@@ -24,6 +24,6 @@
|
|
|
24
24
|
{%- endfor -%}
|
|
25
25
|
{%- for workspace in workspace_dirs -%}
|
|
26
26
|
{%- assign level = workspace | append: "temp/" | split: "/" | size | minus: 3 %}
|
|
27
|
-
<li class="toctree-l{{ level }}">{% include
|
|
27
|
+
<li class="toctree-l{{ level }}">{% include extend/toctree.liquid %}</li>
|
|
28
28
|
{%- endfor -%}
|
|
29
29
|
</ul>
|
data/_includes/footer.liquid
CHANGED
|
@@ -14,14 +14,21 @@
|
|
|
14
14
|
</div>
|
|
15
15
|
{%- endif -%}
|
|
16
16
|
<hr>
|
|
17
|
-
|
|
18
|
-
<
|
|
19
|
-
<
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
{
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
17
|
+
{%- if site.copyright -%}
|
|
18
|
+
<div role="contentinfo" class="copyright">
|
|
19
|
+
<p>
|
|
20
|
+
<i class="fa fa-copyright"></i> {{ __copyright }}
|
|
21
|
+
{% if site.copyright.since -%}
|
|
22
|
+
{{ site.copyright.since | append: "-" }}
|
|
23
|
+
{%- endif -%}
|
|
24
|
+
{{ site.time | date: "%Y" }},
|
|
25
|
+
{{ author }}
|
|
26
|
+
{% if site.copyright.revision -%}
|
|
27
|
+
<span class="commit">
|
|
28
|
+
{{ __revision }} <code>{{ commit }}</code>
|
|
29
|
+
</span>
|
|
30
|
+
{%- endif -%}
|
|
31
|
+
</p>
|
|
32
|
+
</div>
|
|
33
|
+
{%- endif -%}
|
|
27
34
|
</footer>
|
data/_includes/list.liquid
CHANGED
|
@@ -2,5 +2,9 @@
|
|
|
2
2
|
{%- include reset/workspace.liquid workspace=page.dir -%}
|
|
3
3
|
|
|
4
4
|
{%- for item in workspace_files %}
|
|
5
|
-
|
|
5
|
+
- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
|
|
6
6
|
{%- endfor -%}
|
|
7
|
+
|
|
8
|
+
{%- if include.all -%}
|
|
9
|
+
{%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}
|
|
10
|
+
{%- endif -%}
|
|
@@ -1,11 +1,7 @@
|
|
|
1
1
|
{%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
|
|
2
2
|
{%- assign schema_url = page.url | absolute_url | xml_escape -%}
|
|
3
3
|
{%- assign schema_lastmod = site.time | date_to_xmlschema -%}
|
|
4
|
-
{%- assign version = "0.1.
|
|
5
|
-
|
|
6
|
-
{%- assign author = site.author | default: site.github.owner_name -%}
|
|
7
|
-
{%- assign commit = site.github.build_revision | slice: 0, 7 -%}
|
|
8
|
-
{%- assign repository_url = site.github.repository_url -%}
|
|
4
|
+
{%- assign version = "0.1.6" -%}
|
|
9
5
|
|
|
10
6
|
{%- if site.debug -%}
|
|
11
7
|
{%- assign cdn = site.baseurl -%}
|
|
@@ -14,13 +10,19 @@
|
|
|
14
10
|
{%- endif -%}
|
|
15
11
|
|
|
16
12
|
{%- if jekyll.environment == "production" -%}
|
|
13
|
+
{%- assign author = site.author | default: site.github.owner_name -%}
|
|
14
|
+
{%- assign commit = site.github.build_revision | slice: 0, 7 -%}
|
|
15
|
+
{%- assign repository_url = site.github.repository_url -%}
|
|
17
16
|
{%- assign issues_url = site.github.issues_url -%}
|
|
18
17
|
{%- assign zip_url = site.github.zip_url -%}
|
|
19
18
|
{%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
|
|
20
19
|
{%- else -%}
|
|
20
|
+
{%- assign author = site.author | default: "[author]" -%}
|
|
21
|
+
{%- assign commit = "[commit]" -%}
|
|
22
|
+
{%- assign repository_url = "#" -%}
|
|
21
23
|
{%- assign issues_url = "#" -%}
|
|
22
24
|
{%- assign zip_url = "#" -%}
|
|
23
25
|
{%- assign github_edit_link = "#" -%}
|
|
24
26
|
{%- endif -%}
|
|
25
27
|
|
|
26
|
-
{%- assign addons =
|
|
28
|
+
{%- assign addons = "github, gems, analytics" | split: ", " -%}
|
data/_layouts/default.liquid
CHANGED
|
@@ -5,6 +5,15 @@ layout: plugins/compress
|
|
|
5
5
|
{%- include reset/start.liquid -%}
|
|
6
6
|
|
|
7
7
|
<!DOCTYPE html>
|
|
8
|
+
|
|
9
|
+
<!--
|
|
10
|
+
{% if site.remote_theme -%}
|
|
11
|
+
remote_theme: {{ site.remote_theme }}
|
|
12
|
+
{%- else -%}
|
|
13
|
+
theme: {{ site.theme }} v{{ version }}
|
|
14
|
+
{%- endif %}
|
|
15
|
+
-->
|
|
16
|
+
|
|
8
17
|
<html class="writer-html5" lang="{{ lang }}">
|
|
9
18
|
|
|
10
19
|
<head>
|
|
@@ -15,7 +24,7 @@ layout: plugins/compress
|
|
|
15
24
|
<meta name="description" content="{{ description }}">
|
|
16
25
|
<meta name="author" content="{{ author }}">
|
|
17
26
|
<meta name="revised" content="{{ commit }}">
|
|
18
|
-
<meta name="generator" content="
|
|
27
|
+
<meta name="generator" content="jekyll-rtd-theme v{{ version }}">
|
|
19
28
|
<!-- custom meta -->
|
|
20
29
|
{% for meta in site.meta -%}
|
|
21
30
|
<meta name="{{ meta.first }}" content="{{ meta.last }}">
|
|
@@ -50,13 +59,17 @@ layout: plugins/compress
|
|
|
50
59
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
51
60
|
<div class="wy-side-scroll">
|
|
52
61
|
<div class="wy-side-nav-search">
|
|
53
|
-
|
|
54
|
-
{{ site.
|
|
55
|
-
|
|
62
|
+
{% if site.logo %}
|
|
63
|
+
<a href="{{ site.baseurl }}/">
|
|
64
|
+
<img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
|
|
65
|
+
</a>
|
|
66
|
+
{% else %}
|
|
67
|
+
<a href="{{ site.baseurl }}/" class="icon icon-home"> {{ site.title }}</a>
|
|
68
|
+
{% endif %}
|
|
56
69
|
{% include searchbox.liquid %}
|
|
57
70
|
</div>
|
|
58
71
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
59
|
-
{% include
|
|
72
|
+
{% include toctree.liquid %}
|
|
60
73
|
</div>
|
|
61
74
|
{%- if site.embed -%}
|
|
62
75
|
<div class="wy-embed-wrap">
|
|
@@ -82,14 +95,14 @@ layout: plugins/compress
|
|
|
82
95
|
<div class="section">{{ content }}</div>
|
|
83
96
|
{%- endif %}
|
|
84
97
|
</div>
|
|
85
|
-
|
|
98
|
+
{% include addons/comments/disqus.liquid %}
|
|
86
99
|
</div>
|
|
87
100
|
{% include footer.liquid %}
|
|
88
101
|
</div>
|
|
89
102
|
</div>
|
|
90
103
|
</section>
|
|
91
104
|
</div>
|
|
92
|
-
{%- include
|
|
105
|
+
{%- if site.addons %}{% include addons.liquid %}{% endif %}
|
|
93
106
|
<!-- analytics -->
|
|
94
107
|
{%- include addons/analytics/baidu.liquid -%}
|
|
95
108
|
{%- include addons/analytics/cnzz.liquid -%}
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-rtd-theme
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- saowang
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2020-07-
|
|
11
|
+
date: 2020-07-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: github-pages
|
|
@@ -33,9 +33,11 @@ extra_rdoc_files: []
|
|
|
33
33
|
files:
|
|
34
34
|
- LICENSE
|
|
35
35
|
- README.md
|
|
36
|
+
- _includes/addons.liquid
|
|
36
37
|
- _includes/addons/analytics/baidu.liquid
|
|
37
38
|
- _includes/addons/analytics/cnzz.liquid
|
|
38
39
|
- _includes/addons/analytics/google.liquid
|
|
40
|
+
- _includes/addons/comments/disqus.liquid
|
|
39
41
|
- _includes/addons/seo/og.liquid
|
|
40
42
|
- _includes/addons/seo/schema.liquid
|
|
41
43
|
- _includes/addons/source/analytics.liquid
|
|
@@ -46,6 +48,9 @@ files:
|
|
|
46
48
|
- _includes/assets/js/script.js
|
|
47
49
|
- _includes/assets/search.liquid
|
|
48
50
|
- _includes/breadcrumbs.liquid
|
|
51
|
+
- _includes/extend/list.liquid
|
|
52
|
+
- _includes/extend/tabs.liquid
|
|
53
|
+
- _includes/extend/toctree.liquid
|
|
49
54
|
- _includes/footer.liquid
|
|
50
55
|
- _includes/i18n/en.liquid
|
|
51
56
|
- _includes/i18n/zh.liquid
|
|
@@ -60,9 +65,7 @@ files:
|
|
|
60
65
|
- _includes/reset/variables.liquid
|
|
61
66
|
- _includes/reset/workspace.liquid
|
|
62
67
|
- _includes/searchbox.liquid
|
|
63
|
-
- _includes/
|
|
64
|
-
- _includes/toctree_ln.liquid
|
|
65
|
-
- _includes/versions.liquid
|
|
68
|
+
- _includes/toctree.liquid
|
|
66
69
|
- _layouts/default.liquid
|
|
67
70
|
- _layouts/plugins/compress.liquid
|
|
68
71
|
- _sass/embed.scss
|