jekyll-rtd-theme 0.1.8 → 1.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/_includes/addons.liquid +4 -2
  4. data/_includes/addons/analytics/baidu.liquid +13 -13
  5. data/_includes/addons/analytics/google.liquid +8 -14
  6. data/_includes/addons/comments/disqus.liquid +1 -1
  7. data/_includes/addons/seo/og.liquid +1 -1
  8. data/_includes/addons/seo/schema.liquid +1 -1
  9. data/_includes/addons/source/analytics.liquid +1 -3
  10. data/_includes/addons/source/i18n.liquid +13 -0
  11. data/_includes/addons/source/{gems.liquid → plugins.liquid} +1 -1
  12. data/_includes/album.liquid +7 -0
  13. data/_includes/assets/common.js +40 -0
  14. data/_includes/assets/{js/custom.js → custom.js} +0 -0
  15. data/{_sass → _includes/assets}/custom.scss +0 -0
  16. data/_includes/assets/search.js +76 -0
  17. data/_includes/breadcrumbs.liquid +8 -2
  18. data/_includes/extend/toctree.liquid +10 -0
  19. data/_includes/footer.liquid +2 -2
  20. data/_includes/i18n/en.liquid +4 -2
  21. data/_includes/i18n/fr.liquid +29 -0
  22. data/_includes/i18n/it.liquid +29 -0
  23. data/_includes/i18n/ja.liquid +29 -0
  24. data/_includes/i18n/ko.liquid +29 -0
  25. data/_includes/i18n/ru.liquid +29 -0
  26. data/_includes/i18n/{zh.liquid → zh-cn.liquid} +3 -1
  27. data/_includes/reset/defaults.liquid +32 -21
  28. data/_includes/reset/i18n.liquid +30 -2
  29. data/_includes/reset/languages.liquid +110 -0
  30. data/_includes/reset/schema.liquid +4 -0
  31. data/_includes/reset/workdir.liquid +17 -1
  32. data/_layouts/default.liquid +57 -10
  33. data/_sass/_album.scss +25 -0
  34. data/_sass/_embed.scss +14 -16
  35. data/_sass/fluid.scss +1 -1
  36. data/_sass/{style.scss → site.scss} +20 -16
  37. data/assets/404.liquid +9 -0
  38. data/assets/favicon.svg +1 -1
  39. data/assets/js/html5shiv.min.js +4 -0
  40. data/assets/search.liquid +28 -0
  41. data/assets/sitemap.xml +1 -1
  42. metadata +23 -15
  43. data/_includes/assets/404.liquid +0 -5
  44. data/_includes/assets/js/core.js +0 -106
  45. data/_includes/assets/search.liquid +0 -7
  46. data/_includes/searchbox.liquid +0 -5
  47. data/assets/404.md +0 -5
  48. data/assets/search.md +0 -5
@@ -0,0 +1,29 @@
1
+ {% comment %} Japanese {% endcomment %}
2
+ {%- assign __github = "Github" -%}
3
+ {%- assign __homepage = "ホームページ" -%}
4
+ {%- assign __issues = "問題" -%}
5
+ {%- assign __download = "ダウンロード" -%}
6
+ {%- assign __plugins = "テーマプラグイン" -%}
7
+ {%- assign __translations = "翻訳" -%}
8
+ {%- assign __statistics = "統計学" -%}
9
+ {%- assign __total_visits = "総訪問数:" -%}
10
+
11
+ {%- assign __note = "備考" -%}
12
+ {%- assign __tip = "チップ" -%}
13
+ {%- assign __warning = "警告" -%}
14
+ {%- assign __danger = "危険" -%}
15
+
16
+ {%- assign __next = "次のページ" -%}
17
+ {%- assign __previous = "前のページ" -%}
18
+ {%- assign __copyright = "著作権" -%}
19
+ {%- assign __revision = "リビジョン" -%}
20
+
21
+ {%- assign __404 = "404" -%}
22
+ {%- assign __not_found = "このページはまだ存在しません!" -%}
23
+
24
+ {%- assign __searching = "探す" -%}
25
+ {%- assign __search = "探す" -%}
26
+ {%- assign __search_docs = "ドキュメントを検索" -%}
27
+ {%- assign __search_results = "の検索結果" -%}
28
+ {%- assign __search_results_found = "検索が終了し、検索クエリに一致する「#」ページが見つかりました。" -%}
29
+ {%- assign __search_results_not_found = "検索はどのドキュメントにも一致しませんでした。すべての文字のスペルが正しいことを確認してください!" -%}
@@ -0,0 +1,29 @@
1
+ {% comment %} Korean {% endcomment %}
2
+ {%- assign __github = "Github" -%}
3
+ {%- assign __homepage = "홈페이지" -%}
4
+ {%- assign __issues = "이슈" -%}
5
+ {%- assign __download = "다운로드" -%}
6
+ {%- assign __plugins = "테마 플러그인" -%}
7
+ {%- assign __translations = "번역" -%}
8
+ {%- assign __statistics = "통계" -%}
9
+ {%- assign __total_visits = "총 방문수 :" -%}
10
+
11
+ {%- assign __note = "비고" -%}
12
+ {%- assign __tip = "팁" -%}
13
+ {%- assign __warning = "경고" -%}
14
+ {%- assign __danger = "위험" -%}
15
+
16
+ {%- assign __next = "다음 페이지" -%}
17
+ {%- assign __previous = "이전 페이지" -%}
18
+ {%- assign __copyright = "저작권" -%}
19
+ {%- assign __revision = "개정" -%}
20
+
21
+ {%- assign __404 = "404" -%}
22
+ {%- assign __not_found = "이 페이지는 아직 존재하지 않습니다!" -%}
23
+
24
+ {%- assign __searching = "수색" -%}
25
+ {%- assign __search = "검색" -%}
26
+ {%- assign __search_docs = "문서 검색" -%}
27
+ {%- assign __search_results = "검색 결과" -%}
28
+ {%- assign __search_results_found = "검색이 완료되었습니다. 검색어와 일치하는 # 페이지를 찾았습니다." -%}
29
+ {%- assign __search_results_not_found = "검색어와 일치하는 문서가 없습니다. 모든 문자의 철자가 올바른지 확인하십시오!" -%}
@@ -0,0 +1,29 @@
1
+ {% comment %} Russian {% endcomment %}
2
+ {%- assign __github = "Github" -%}
3
+ {%- assign __homepage = "домашняя страница" -%}
4
+ {%- assign __issues = "вопросы" -%}
5
+ {%- assign __download = "Скачать" -%}
6
+ {%- assign __plugins = "Плагины тем" -%}
7
+ {%- assign __translations = "Переводы" -%}
8
+ {%- assign __statistics = "Статистика" -%}
9
+ {%- assign __total_visits = "Всего посещений:" -%}
10
+
11
+ {%- assign __note = "замечания" -%}
12
+ {%- assign __tip = "подсказки" -%}
13
+ {%- assign __warning = "Предупреждение" -%}
14
+ {%- assign __danger = "Опасность" -%}
15
+
16
+ {%- assign __next = "Следующая Страница" -%}
17
+ {%- assign __previous = "Предыдущая страница" -%}
18
+ {%- assign __copyright = "авторское право" -%}
19
+ {%- assign __revision = "пересмотр" -%}
20
+
21
+ {%- assign __404 = "404" -%}
22
+ {%- assign __not_found = "Эта страница еще не существует!" -%}
23
+
24
+ {%- assign __searching = "Поиск" -%}
25
+ {%- assign __search = "Поиск" -%}
26
+ {%- assign __search_docs = "Искать в Документах" -%}
27
+ {%- assign __search_results = "результаты поиска" -%}
28
+ {%- assign __search_results_found = "Поиск завершен, найдено # страниц, соответствующих поисковому запросу." -%}
29
+ {%- assign __search_results_not_found = "По вашему запросу не найдено ни одного документа, убедитесь, что все символы написаны правильно!" -%}
@@ -1,8 +1,10 @@
1
+ {% comment %} Chinese Simplified {% endcomment %}
1
2
  {%- assign __github = "开源文档" -%}
2
3
  {%- assign __homepage = "仓库" -%}
3
4
  {%- assign __issues = "反馈" -%}
4
5
  {%- assign __download = "下载" -%}
5
- {%- assign __gems = "主题插件" -%}
6
+ {%- assign __plugins = "主题插件" -%}
7
+ {%- assign __translations = "文档翻译" -%}
6
8
  {%- assign __statistics = "访问统计" -%}
7
9
  {%- assign __total_visits = "累计浏览次数:" -%}
8
10
 
@@ -1,42 +1,53 @@
1
1
  {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
2
- {%- assign version = "0.1.8" -%}
3
- {%- assign addons = "github, gems, analytics" | split: ", " -%}
2
+ {%- assign version = "1.0.3" -%}
3
+ {%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
4
4
 
5
5
  {%- include reset/site_pages.liquid %}
6
6
  {%- include reset/i18n.liquid -%}
7
7
  {%- include reset/schema.liquid -%}
8
8
 
9
9
  {% comment %} github-metadata {% endcomment %}
10
- {%- if jekyll.environment != "production" -%}
11
- {%- assign author = site.author | default: "[author]" -%}
12
- {%- assign branch = "[branch]" -%}
13
- {%- assign commit = "[commit]" -%}
14
- {%- assign repository_url = "#" -%}
15
- {%- assign issues_url = "#" -%}
16
- {%- assign zip_url = "#" -%}
17
- {%- assign github_edit_link = "#" -%}
10
+ {%- if site.github_metadata != false -%}
11
+ {%- if jekyll.environment == "production" -%}
12
+ {%- assign author = site.author | default: site.github.owner_name -%}
13
+ {%- assign branch = site.github.source.branch -%}
14
+ {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
15
+ {%- assign repository_url = site.github.repository_url -%}
16
+ {%- assign issues_url = site.github.issues_url -%}
17
+ {%- assign zip_url = site.github.zip_url -%}
18
+ {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
19
+ {%- else -%}
20
+ {%- assign author = site.author | default: "[author]" -%}
21
+ {%- assign branch = "[branch]" -%}
22
+ {%- assign commit = "[commit]" -%}
23
+ {%- assign repository_url = "#" -%}
24
+ {%- assign issues_url = "#" -%}
25
+ {%- assign zip_url = "#" -%}
26
+ {%- assign github_edit_link = "#" -%}
27
+ {%- endif -%}
18
28
  {%- else -%}
19
- {%- assign author = site.author | default: site.github.owner_name -%}
20
- {%- assign branch = site.github.source.branch -%}
21
- {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
22
- {%- assign repository_url = site.github.repository_url -%}
23
- {%- assign issues_url = site.github.issues_url -%}
24
- {%- assign zip_url = site.github.zip_url -%}
25
- {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
29
+ {%- assign author = site.author | default: "[author]" -%}
30
+ {%- assign branch = "" -%}
31
+ {%- assign commit = "" -%}
32
+ {%- assign repository_url = "" -%}
33
+ {%- assign issues_url = "" -%}
34
+ {%- assign zip_url = "" -%}
35
+ {%- assign github_edit_link = "" -%}
36
+ {%- assign addons = "i18n, plugins, analytics" | split: ", " -%}
26
37
  {%- endif -%}
27
38
 
28
39
  {% comment %} scss and script {% endcomment %}
29
40
  {%- capture site_scss -%}
30
- @import "style.scss";
41
+ @import "site.scss";
31
42
  {%- if site.fluid %}
32
43
  @import "fluid.scss";
33
44
  {% endif -%}
34
- @import "custom.scss"; {{ site.scss }}
45
+ {% include assets/custom.scss %} {{ site.scss }}
35
46
  {%- endcapture -%}
36
47
 
37
48
  {%- capture site_script %}
38
- {% include assets/js/core.js %}
39
- {% include assets/js/custom.js %} {{ site.script }}
49
+ {% include assets/common.js %}
50
+ {% include assets/custom.js %} {{ site.script }}
40
51
  {%- endcapture -%}
41
52
 
42
53
  {%- if site.debug -%}
@@ -1,3 +1,31 @@
1
- {%- assign lang = site.lang | default: "en-US" -%}
1
+ {%- include reset/languages.liquid -%}
2
2
 
3
- {%- include i18n/{{ lang | split: "-" | first }}.liquid -%}
3
+ {% comment %} Set default lang {% endcomment %}
4
+ {%- assign site_lang = "en" -%}
5
+ {%- if languages contains site.lang -%}
6
+ {%- assign site_lang = site.lang -%}
7
+ {%- endif -%}
8
+
9
+ {% comment %} Get docs all avaiable langs {% endcomment %}
10
+ {%- capture langs -%}
11
+ {{ site_lang }}|
12
+ {%- for item in site_dirs -%}
13
+ {%- assign chapter = item.dir | remove_first: "/" | split: "/" | first -%}
14
+ {%- if languages contains chapter -%}
15
+ {{ chapter }}|
16
+ {%- endif -%}
17
+ {%- endfor -%}
18
+ {%- endcapture -%}
19
+ {%- assign site_langs = langs | split: "|" | uniq -%}
20
+
21
+ {% comment %} include language by the root subdirectory {% endcomment %}
22
+ {%- assign lang = site_lang -%}
23
+
24
+ {%- if page.dir != "/" -%}
25
+ {%- assign chapter = page.dir | remove_first: "/" | split: "/" | first -%}
26
+ {%- if languages contains chapter -%}
27
+ {%- assign lang = chapter -%}
28
+ {%- endif -%}
29
+ {%- endif -%}
30
+
31
+ {%- include i18n/{{ lang }}.liquid -%}
@@ -0,0 +1,110 @@
1
+ {% comment %} https://cloud.google.com/translate/docs/languages ISO-639-1 {% endcomment %}
2
+ {% comment %} https://github.com/matheuss/google-translate-api/blob/master/languages.js {% endcomment %}
3
+ {%- capture iso_codes -%}
4
+ af
5
+ sq
6
+ am
7
+ ar
8
+ hy
9
+ az
10
+ eu
11
+ be
12
+ bn
13
+ bs
14
+ bg
15
+ ca
16
+ ceb
17
+ ny
18
+ zh-cn
19
+ zh-tw
20
+ co
21
+ hr
22
+ cs
23
+ da
24
+ nl
25
+ en
26
+ eo
27
+ et
28
+ tl
29
+ fi
30
+ fr
31
+ fy
32
+ gl
33
+ ka
34
+ de
35
+ el
36
+ gu
37
+ ht
38
+ ha
39
+ haw
40
+ iw
41
+ hi
42
+ hmn
43
+ hu
44
+ is
45
+ ig
46
+ id
47
+ ga
48
+ it
49
+ ja
50
+ jw
51
+ kn
52
+ kk
53
+ km
54
+ ko
55
+ ku
56
+ ky
57
+ lo
58
+ la
59
+ lv
60
+ lt
61
+ lb
62
+ mk
63
+ mg
64
+ ms
65
+ ml
66
+ mt
67
+ mi
68
+ mr
69
+ mn
70
+ my
71
+ ne
72
+ no
73
+ ps
74
+ fa
75
+ pl
76
+ pt
77
+ ma
78
+ ro
79
+ ru
80
+ sm
81
+ gd
82
+ sr
83
+ st
84
+ sn
85
+ sd
86
+ si
87
+ sk
88
+ sl
89
+ so
90
+ es
91
+ su
92
+ sw
93
+ sv
94
+ tg
95
+ ta
96
+ te
97
+ th
98
+ tr
99
+ uk
100
+ ur
101
+ uz
102
+ vi
103
+ cy
104
+ xh
105
+ yi
106
+ yo
107
+ zu
108
+ {%- endcapture -%}
109
+
110
+ {%- assign languages = iso_codes | split: " " -%}
@@ -1,2 +1,6 @@
1
1
  {%- assign schema_url = page.url | absolute_url | xml_escape -%}
2
2
  {%- assign schema_lastmod = page.date | default: site.time | date_to_xmlschema -%}
3
+
4
+ {%- assign schema_weight_title = page.title | size | divided_by: 200.0 -%}
5
+ {%- assign schema_weight_content = page.content | size | divided_by: 1024.0 -%}
6
+ {%- assign schema_priority = schema_weight_content | plus: schema_weight_title | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 -%}
@@ -1,4 +1,13 @@
1
+ {% comment %} Start from the language chapter(eg: en-us) or root(/) {% endcomment %}
1
2
  {%- assign workdir = include.workdir | default: "/" -%}
3
+
4
+ {%- if page.dir != "/" -%}
5
+ {%- assign chapter = page.dir | remove_first: "/" | split: "/" | first -%}
6
+ {%- if languages contains chapter -%}
7
+ {%- capture workdir %}/{{ chapter }}/{% endcapture -%}
8
+ {%- endif -%}
9
+ {%- endif -%}
10
+
2
11
  {%- assign workdir_level = workdir | append: "temp/" | split: "/" | size | minus: 1 -%}
3
12
  {%- assign workdir_files = site_files | where_exp: "item", "item.dir == workdir" -%}
4
13
 
@@ -8,8 +17,15 @@
8
17
  {%- if workdir_level == current_m1 -%}
9
18
  {%- assign temp = workdir | append: "@@" -%}
10
19
  {%- assign dir = item.dir | replace: workdir, temp | split: "@@" | first -%}
20
+ {% comment %} In the current subdirectory {% endcomment %}
11
21
  {%- if workdir == dir -%}
12
- {{ item.dir }}|
22
+ {% comment %} Root directory does not display other languages {% endcomment %}
23
+ {%- if workdir == "/" -%}
24
+ {%- assign language = item.dir | replace: "/", "" -%}
25
+ {%- unless languages contains language %}{{ item.dir }}|{% endunless -%}
26
+ {%- else -%}
27
+ {{ item.dir }}|
28
+ {%- endif -%}
13
29
  {%- endif -%}
14
30
  {%- endif -%}
15
31
  {%- endfor -%}
@@ -8,9 +8,9 @@ layout: plugins/compress
8
8
 
9
9
  <!--
10
10
  {% if site.remote_theme -%}
11
- remote_theme: {{ site.remote_theme }}, based on v{{ version }}
11
+ rundocs.io, remote_theme: {{ site.remote_theme }}, based on v{{ version }}
12
12
  {%- else -%}
13
- theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
13
+ rundocs.io, theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
14
14
  {%- endif %}
15
15
  -->
16
16
 
@@ -19,7 +19,23 @@ layout: plugins/compress
19
19
  <head>
20
20
  <meta charset="utf-8">
21
21
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
22
+ <meta content="IE=Edge" http-equiv="X-UA-Compatible">
22
23
  <title>{{ title }}</title>
24
+ <script>
25
+ window.dataLayer = window.dataLayer || [];
26
+
27
+ function gtag() {
28
+ dataLayer.push(arguments);
29
+ }
30
+
31
+ function feedback(messages) {
32
+ gtag("event", "exception", {
33
+ "description": messages.join(":")
34
+ });
35
+ }
36
+
37
+ gtag("js", new Date());
38
+ </script>
23
39
  <!-- meta -->
24
40
  <meta name="description" content="{{ description }}">
25
41
  <meta name="author" content="{{ author }}">
@@ -48,10 +64,32 @@ layout: plugins/compress
48
64
  <!-- icon -->
49
65
  <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/assets/favicon.svg">
50
66
  <!-- script -->
67
+ <!--[if lt IE 9]>
68
+ <script src="{{ cdn }}/assets/js/html5shiv.min.js"></script>
69
+ <![endif]-->
51
70
  <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
52
- <script src="{{ cdn }}/assets/js/theme.js"></script>
53
- <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
54
- <script>{{ site_script }}</script>
71
+ <script>
72
+ const ui = {
73
+ baseurl: "{{ site.baseurl }}",
74
+ title: "{{ site.title }}",
75
+ lang: "{{ lang }}",
76
+ admonition: {
77
+ note: "{{ __note }}",
78
+ tip: "{{ __tip }}",
79
+ warning: "{{ __warning }}",
80
+ danger: "{{ __danger }}"
81
+ }
82
+ };
83
+ </script>
84
+ {%- if jekyll.environment == "production" -%}
85
+ <script async src="https://www.googletagmanager.com/gtag/js?id=UA-174262874-1"></script>
86
+ <script>
87
+ gtag("set", {
88
+ "user_id": location.host
89
+ });
90
+ gtag("config", "UA-174262874-1");
91
+ </script>
92
+ {%- endif -%}
55
93
  </head>
56
94
 
57
95
  <body class="wy-body-for-nav">
@@ -61,13 +99,18 @@ layout: plugins/compress
61
99
  <div class="wy-side-scroll">
62
100
  <div class="wy-side-nav-search">
63
101
  {% if site.logo %}
64
- <a href="{{ site.baseurl }}/">
102
+ <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">
65
103
  <img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
66
104
  </a>
67
105
  {% else %}
68
- <a href="{{ site.baseurl }}/" class="icon icon-home"> {{ site.title }}</a>
106
+ <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}" class="icon icon-home"> {{ site.title }}</a>
69
107
  {% endif %}
70
- {% include searchbox.liquid %}
108
+ <div role="search">
109
+ <form id="rtd-search-form" class="wy-form" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
110
+ <input type="text" name="q" placeholder="{{ __search_docs }}...">
111
+ <input type="hidden" name="lang" value="{{ lang }}">
112
+ </form>
113
+ </div>
71
114
  </div>
72
115
  <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
73
116
  {% include toctree.liquid %}
@@ -83,7 +126,7 @@ layout: plugins/compress
83
126
  <!-- MOBILE NAV -->
84
127
  <nav class="wy-nav-top" aria-label="top navigation">
85
128
  <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
86
- <a href="{{ site.baseurl }}/">{{ site.title }}</a>
129
+ <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">{{ site.title }}</a>
87
130
  </nav>
88
131
  <div class="wy-nav-content">
89
132
  <div class="rst-content">
@@ -94,7 +137,7 @@ layout: plugins/compress
94
137
  {{ content }}
95
138
  {%- else -%}
96
139
  <div class="section">{{ content }}</div>
97
- {%- endif %}
140
+ {%- endif -%}
98
141
  </div>
99
142
  {% include addons/comments/disqus.liquid %}
100
143
  </div>
@@ -104,6 +147,10 @@ layout: plugins/compress
104
147
  </section>
105
148
  </div>
106
149
  {%- if site.addons %}{% include addons.liquid %}{% endif %}
150
+ <!-- script -->
151
+ <script src="{{ cdn }}/assets/js/theme.js"></script>
152
+ <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
153
+ <script>{{ site_script }}</script>
107
154
  <!-- analytics -->
108
155
  {%- include addons/analytics/baidu.liquid -%}
109
156
  {%- include addons/analytics/cnzz.liquid -%}