truesight-rtd-theme 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +7 -0
  2. data/LICENSE +21 -0
  3. data/README.md +100 -0
  4. data/_includes/README.md +9 -0
  5. data/_includes/common/assets/data.liquid +3 -0
  6. data/_includes/common/assets/robots.liquid +4 -0
  7. data/_includes/common/assets/sitemap.liquid +12 -0
  8. data/_includes/common/assets/sw.caches.js +39 -0
  9. data/_includes/common/core/_list.liquid +15 -0
  10. data/_includes/common/core/list.liquid +10 -0
  11. data/_includes/common/google_adsense.liquid +3 -0
  12. data/_includes/common/google_gtag.liquid +11 -0
  13. data/_includes/common/links.liquid +26 -0
  14. data/_includes/common/mathjax.liquid +6 -0
  15. data/_includes/common/mermaid.liquid +10 -0
  16. data/_includes/common/metadata.liquid +12 -0
  17. data/_includes/common/opengraph.liquid +8 -0
  18. data/_includes/common/rest/content.liquid +6 -0
  19. data/_includes/common/rest/defaults.liquid +7 -0
  20. data/_includes/common/rest/description.liquid +6 -0
  21. data/_includes/common/rest/i18n.liquid +1 -0
  22. data/_includes/common/rest/nav.liquid +20 -0
  23. data/_includes/common/rest/site_pages.liquid +8 -0
  24. data/_includes/common/rest/tabs.liquid +2 -0
  25. data/_includes/common/rest/title.liquid +18 -0
  26. data/_includes/common/rest/variables.liquid +41 -0
  27. data/_includes/common/rest/workdir.liquid +19 -0
  28. data/_includes/common/schema.liquid +27 -0
  29. data/_includes/common/script.liquid +11 -0
  30. data/_includes/common/title.liquid +1 -0
  31. data/_includes/common/twitter_cards.liquid +6 -0
  32. data/_includes/extra/body.html +0 -0
  33. data/_includes/extra/head.html +0 -0
  34. data/_includes/extra/script.js +0 -0
  35. data/_includes/extra/styles.scss +0 -0
  36. data/_includes/list.liquid +1 -0
  37. data/_includes/rest/defaults.liquid +2 -0
  38. data/_includes/rest/script.liquid +7 -0
  39. data/_includes/rest/styles.liquid +5 -0
  40. data/_includes/shortcodes/danger.liquid +9 -0
  41. data/_includes/shortcodes/mermaid.liquid +3 -0
  42. data/_includes/shortcodes/note.liquid +9 -0
  43. data/_includes/shortcodes/tip.liquid +9 -0
  44. data/_includes/shortcodes/warning.liquid +9 -0
  45. data/_includes/templates/_toctree.liquid +41 -0
  46. data/_includes/templates/addons.liquid +43 -0
  47. data/_includes/templates/breadcrumbs.liquid +33 -0
  48. data/_includes/templates/content.liquid +20 -0
  49. data/_includes/templates/footer.liquid +54 -0
  50. data/_includes/templates/sidebar.liquid +18 -0
  51. data/_includes/templates/toctree.liquid +23 -0
  52. data/_layouts/default.liquid +32 -0
  53. data/_layouts/tasks/compress.liquid +21 -0
  54. data/_layouts/tasks/shortcodes.liquid +33 -0
  55. data/_sass/_direction.scss +107 -0
  56. data/_sass/_font-face.scss +66 -0
  57. data/_sass/_layout.scss +76 -0
  58. data/_sass/_rest.scss +26 -0
  59. data/_sass/_root.scss +9 -0
  60. data/_sass/_variables.scss +34 -0
  61. data/_sass/core/addons.scss +39 -0
  62. data/_sass/core/container.scss +11 -0
  63. data/_sass/core/content.scss +4 -0
  64. data/_sass/core/header.scss +10 -0
  65. data/_sass/core/markdown.scss +113 -0
  66. data/_sass/core/sidebar.scss +100 -0
  67. data/_sass/core/title.scss +12 -0
  68. data/_sass/core/toasts.scss +53 -0
  69. data/_sass/lib/@primer/css/base/README.md +24 -0
  70. data/_sass/lib/@primer/css/base/base.scss +90 -0
  71. data/_sass/lib/@primer/css/base/index.scss +6 -0
  72. data/_sass/lib/@primer/css/base/kbd.scss +21 -0
  73. data/_sass/lib/@primer/css/base/normalize.scss +424 -0
  74. data/_sass/lib/@primer/css/base/typography-base.scss +100 -0
  75. data/_sass/lib/@primer/css/breadcrumb/README.md +24 -0
  76. data/_sass/lib/@primer/css/breadcrumb/breadcrumb.scss +28 -0
  77. data/_sass/lib/@primer/css/breadcrumb/index.scss +3 -0
  78. data/_sass/lib/@primer/css/buttons/README.md +24 -0
  79. data/_sass/lib/@primer/css/buttons/button-group.scss +91 -0
  80. data/_sass/lib/@primer/css/buttons/button.scss +296 -0
  81. data/_sass/lib/@primer/css/buttons/index.scss +4 -0
  82. data/_sass/lib/@primer/css/buttons/misc.scss +205 -0
  83. data/_sass/lib/@primer/css/forms/README.md +24 -0
  84. data/_sass/lib/@primer/css/forms/form-control.scss +281 -0
  85. data/_sass/lib/@primer/css/forms/form-group.scss +279 -0
  86. data/_sass/lib/@primer/css/forms/form-select.scss +38 -0
  87. data/_sass/lib/@primer/css/forms/form-validation.scss +369 -0
  88. data/_sass/lib/@primer/css/forms/index.scss +7 -0
  89. data/_sass/lib/@primer/css/forms/input-group.scss +53 -0
  90. data/_sass/lib/@primer/css/forms/radio-group.scss +43 -0
  91. data/_sass/lib/@primer/css/loaders/README.md +24 -0
  92. data/_sass/lib/@primer/css/loaders/index.scss +2 -0
  93. data/_sass/lib/@primer/css/loaders/loaders.scss +21 -0
  94. data/_sass/lib/@primer/css/markdown/README.md +24 -0
  95. data/_sass/lib/@primer/css/markdown/blob-csv.scss +31 -0
  96. data/_sass/lib/@primer/css/markdown/code.scss +73 -0
  97. data/_sass/lib/@primer/css/markdown/headings.scss +72 -0
  98. data/_sass/lib/@primer/css/markdown/images.scss +131 -0
  99. data/_sass/lib/@primer/css/markdown/index.scss +8 -0
  100. data/_sass/lib/@primer/css/markdown/lists.scss +77 -0
  101. data/_sass/lib/@primer/css/markdown/markdown-body.scss +99 -0
  102. data/_sass/lib/@primer/css/markdown/tables.scss +38 -0
  103. data/_sass/lib/@primer/css/support/README.md +24 -0
  104. data/_sass/lib/@primer/css/support/index.scss +11 -0
  105. data/_sass/lib/@primer/css/support/mixins/buttons.scss +184 -0
  106. data/_sass/lib/@primer/css/support/mixins/layout.scss +55 -0
  107. data/_sass/lib/@primer/css/support/mixins/misc.scss +32 -0
  108. data/_sass/lib/@primer/css/support/mixins/typography.scss +88 -0
  109. data/_sass/lib/@primer/css/support/variables/color-system.scss +243 -0
  110. data/_sass/lib/@primer/css/support/variables/colors.scss +55 -0
  111. data/_sass/lib/@primer/css/support/variables/layout.scss +149 -0
  112. data/_sass/lib/@primer/css/support/variables/misc.scss +43 -0
  113. data/_sass/lib/@primer/css/support/variables/typography.scss +43 -0
  114. data/_sass/lib/@primer/css/utilities/README.md +24 -0
  115. data/_sass/lib/@primer/css/utilities/animations.scss +187 -0
  116. data/_sass/lib/@primer/css/utilities/borders.scss +187 -0
  117. data/_sass/lib/@primer/css/utilities/box-shadow.scss +25 -0
  118. data/_sass/lib/@primer/css/utilities/colors.scss +185 -0
  119. data/_sass/lib/@primer/css/utilities/details.scss +34 -0
  120. data/_sass/lib/@primer/css/utilities/flexbox.scss +124 -0
  121. data/_sass/lib/@primer/css/utilities/index.scss +14 -0
  122. data/_sass/lib/@primer/css/utilities/layout.scss +151 -0
  123. data/_sass/lib/@primer/css/utilities/margin.scss +68 -0
  124. data/_sass/lib/@primer/css/utilities/padding.scss +59 -0
  125. data/_sass/lib/@primer/css/utilities/typography.scss +325 -0
  126. data/_sass/lib/@primer/css/utilities/visibility-display.scss +82 -0
  127. data/_sass/lib/font-awesome/_icons.scss +2139 -0
  128. data/_sass/lib/font-awesome/_variables.scss +799 -0
  129. data/_sass/lib/material-design-lite/_color-definitions.scss +378 -0
  130. data/_sass/lib/material-design-lite/_functions.scss +19 -0
  131. data/_sass/lib/material-design-lite/_mixins.scss +301 -0
  132. data/_sass/lib/material-design-lite/_variables.scss +612 -0
  133. data/_sass/lib/rouge/github.scss +214 -0
  134. data/_sass/theme.scss +37 -0
  135. data/assets/404.liquid +9 -0
  136. data/assets/css/fonts/Roboto-Slab-Bold.woff +0 -0
  137. data/assets/css/fonts/Roboto-Slab-Bold.woff2 +0 -0
  138. data/assets/css/fonts/Roboto-Slab-Regular.woff +0 -0
  139. data/assets/css/fonts/Roboto-Slab-Regular.woff2 +0 -0
  140. data/assets/css/fonts/fontawesome-webfont.eot +0 -0
  141. data/assets/css/fonts/fontawesome-webfont.svg +2671 -0
  142. data/assets/css/fonts/fontawesome-webfont.ttf +0 -0
  143. data/assets/css/fonts/fontawesome-webfont.woff +0 -0
  144. data/assets/css/fonts/fontawesome-webfont.woff2 +0 -0
  145. data/assets/css/fonts/lato-bold-italic.woff +0 -0
  146. data/assets/css/fonts/lato-bold-italic.woff2 +0 -0
  147. data/assets/css/fonts/lato-bold.woff +0 -0
  148. data/assets/css/fonts/lato-bold.woff2 +0 -0
  149. data/assets/css/fonts/lato-normal-italic.woff +0 -0
  150. data/assets/css/fonts/lato-normal-italic.woff2 +0 -0
  151. data/assets/css/fonts/lato-normal.woff +0 -0
  152. data/assets/css/fonts/lato-normal.woff2 +0 -0
  153. data/assets/css/theme.min.css +1 -0
  154. data/assets/css/theme.scss +4 -0
  155. data/assets/data.liquid +6 -0
  156. data/assets/images/apple-touch-icon-300x300.jpg +0 -0
  157. data/assets/images/favicon-16x16.png +0 -0
  158. data/assets/images/favicon-32x32.png +0 -0
  159. data/assets/images/favicon-96x96.png +0 -0
  160. data/assets/images/favicon.liquid +13 -0
  161. data/assets/js/jquery.min.js +2 -0
  162. data/assets/js/mermaid.min.js +31 -0
  163. data/assets/js/theme.js +287 -0
  164. data/assets/js/theme.min.js +1 -0
  165. data/assets/robots.liquid +6 -0
  166. data/assets/search.liquid +12 -0
  167. data/assets/sitemap.liquid +6 -0
  168. data/assets/sw.caches.liquid +8 -0
  169. metadata +224 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0666f2560ad9a9f414dfec56cfc8dd318849509c290f5bbb8d0fe039a3e02ee1
4
+ data.tar.gz: b71ae3787b0e508348e58e95219bc4dae2854aa05cc5c80a20055a5d6842e27f
5
+ SHA512:
6
+ metadata.gz: 245a9cdf79293d55cda00f29e4ff84fd3400d5dada9ba78a92fa069aba4dd1cca12f17225ce13b4f028da03dd0c91297a9fabe14aba4b895379029cdd2903eb2
7
+ data.tar.gz: 70c02d5ae9cd1d5fd064464854c5f08e51c6a42e3152102e98fe5666121386a32a3476dddb6beb36d7be81f89bcf49e076bbf2eaee94fafdd489d690da3e41cf
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 RunDocs & contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,100 @@
1
+ # jekyll-rtd-theme
2
+
3
+ ![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=develop)
4
+ ![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)
5
+
6
+ Just another documentation theme compatible with GitHub Pages
7
+
8
+ ## What it does?
9
+
10
+ This theme is inspired by [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) and refactored with:
11
+
12
+ - [@primer/css](https://github.com/primer/css)
13
+ - [github-pages](https://github.com/github/pages-gem) ([dependency versions](https://pages.github.com/versions/))
14
+
15
+ ## Quick start
16
+
17
+ ```yml
18
+ remote_theme: rundocs/jekyll-rtd-theme
19
+ ```
20
+
21
+ You can [generate](https://github.com/rundocs/starter-slim/generate) with the same files and folders from [rundocs/starter-slim](https://github.com/rundocs/starter-slim/)
22
+
23
+ ## Usage
24
+
25
+ Documentation that can guide how to create with Github pages, please refer to [rundocs.io](https://rundocs.io) for details
26
+
27
+ ## Features
28
+
29
+ - Shortcodes (Toasts card, mermaid)
30
+ - Pages Plugins (emoji, gist, avatar, mentions)
31
+ - Auto generate sidebar
32
+ - [Attribute List Definitions](https://kramdown.gettalong.org/syntax.html#attribute-list-definitions) (Primer/css utilities, Font Awesome 4)
33
+ - Service worker (caches)
34
+ - SEO (404, robots.txt, sitemap.xml)
35
+ - Canonical Link (Open Graph, Twitter Card, Schema data)
36
+
37
+ ## Options
38
+
39
+ | name | default value | description |
40
+ | ------------- | -------------------- | ----------------- |
41
+ | `title` | repo name | |
42
+ | `description` | repo description | |
43
+ | `url` | user domain or cname | |
44
+ | `baseurl` | repo name | |
45
+ | `lang` | `en` | |
46
+ | `direction` | `auto` | `ltr` or `rtl` |
47
+ | `highlighter` | `rouge` | Cannot be changed |
48
+
49
+ ```yml
50
+ # folders sort
51
+ readme_index:
52
+ with_frontmatter: true
53
+
54
+ meta:
55
+ key1: value1
56
+ key2: value2
57
+ .
58
+ .
59
+ .
60
+
61
+ google:
62
+ gtag:
63
+ adsense:
64
+
65
+ mathjax: # this will prased to json, default: {}
66
+
67
+ mermaid:
68
+ custom: # mermaid link
69
+ initialize: # this will prased to json, default: {}
70
+
71
+ scss: # also _includes/extra/styles.scss
72
+ script: # also _includes/extra/script.js
73
+
74
+ translate:
75
+ # shortcodes
76
+ danger:
77
+ note:
78
+ tip:
79
+ warning:
80
+ # 404
81
+ not_found:
82
+ # copyright
83
+ revision:
84
+ # search
85
+ searching:
86
+ search:
87
+ search_docs:
88
+ search_results:
89
+ search_results_found: # the "#" in this translate will replaced with results size!
90
+ search_results_not_found:
91
+
92
+ plugins:
93
+ - jemoji
94
+ - jekyll-avatar
95
+ - jekyll-mentions
96
+ ```
97
+
98
+ ## The license
99
+
100
+ The theme is available as open source under the terms of the MIT License
@@ -0,0 +1,9 @@
1
+ # Document Statement
2
+
3
+ ## templates
4
+
5
+ Template files for this theme
6
+
7
+ ## common
8
+
9
+ Some common variables and code snippets are designed to be shared by multiple themes
@@ -0,0 +1,3 @@
1
+ {%- include common/rest/site_pages.liquid -%}
2
+
3
+ {{- site_pages | jsonify -}}
@@ -0,0 +1,4 @@
1
+ User-agent: *
2
+ Allow: /
3
+
4
+ Sitemap: {{ "sitemap.xml" | absolute_url }}
@@ -0,0 +1,12 @@
1
+ {%- include common/rest/site_pages.liquid -%}
2
+
3
+ <?xml version="1.0" encoding="UTF-8"?>
4
+ <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
5
+ {%- for page in site_pages -%}
6
+ <url>
7
+ <loc>{{ page.url | absolute_url | xml_escape }}</loc>
8
+ <priority>{{ page.content | size | divided_by: 2048.0 | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 }}</priority>
9
+ <lastmod>{{ site.time | date_to_xmlschema }}</lastmod>
10
+ </url>
11
+ {%- endfor %}
12
+ </urlset>
@@ -0,0 +1,39 @@
1
+ self.addEventListener("activate", function (event) {
2
+ const current = ["{{ theme_alias }}"];
3
+
4
+ event.waitUntil(
5
+ caches.keys().then(function (keyList) {
6
+ return Promise.all(
7
+ keyList.map(function (key) {
8
+ if (current.indexOf(key) === -1) {
9
+ return caches.delete(key);
10
+ }
11
+ })
12
+ );
13
+ })
14
+ );
15
+ });
16
+
17
+ self.addEventListener("fetch", function (e) {
18
+ if (e.request.url.match("{{ theme_alias }}")) {
19
+ e.respondWith(
20
+ caches.match(e.request).then(function (resp) {
21
+ if (resp !== undefined) {
22
+ return resp;
23
+ } else {
24
+ return fetch(e.request, {
25
+ cache: "no-store",
26
+ })
27
+ .then(function (resp) {
28
+ let clone = resp.clone();
29
+ caches.open("{{ theme_alias }}").then(function (cache) {
30
+ cache.put(e.request, clone);
31
+ });
32
+ return resp;
33
+ })
34
+ .catch(console.log);
35
+ }
36
+ })
37
+ );
38
+ }
39
+ });
@@ -0,0 +1,15 @@
1
+ {%- include common/rest/site_pages.liquid -%}
2
+ {%- include common/rest/workdir.liquid -%}
3
+
4
+ {%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
5
+ {%- assign size = workdir_level | minus: base -%}
6
+ {%- assign size_p1 = size | plus: 1 -%}
7
+
8
+ {%- assign dir = site_pages | where: "url", workdir | first %}
9
+ {% include common/rest/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
10
+
11
+ {%- for item in workdir_files %}
12
+ {% include common/rest/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
13
+ {%- endfor -%}
14
+
15
+ {%- for workdir in workdir_dirs %}{% include common/core/_list.liquid %}{% endfor -%}
@@ -0,0 +1,10 @@
1
+ {%- include common/rest/site_pages.liquid -%}
2
+ {%- include common/rest/workdir.liquid workdir=page.dir -%}
3
+
4
+ {%- for item in workdir_files %}
5
+ - [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
6
+ {%- endfor -%}
7
+
8
+ {%- if include.all -%}
9
+ {%- for workdir in workdir_dirs %}{% include common/core/_list.liquid %}{% endfor -%}
10
+ {%- endif -%}
@@ -0,0 +1,3 @@
1
+ {%- if site.google.adsense -%}
2
+ <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
3
+ {%- endif -%}
@@ -0,0 +1,11 @@
1
+ {%- if site.google.gtag -%}
2
+ <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
3
+ <script>
4
+ window.dataLayer = window.dataLayer || [];
5
+ function gtag() {
6
+ dataLayer.push(arguments);
7
+ }
8
+ gtag("js", new Date());
9
+ gtag("config", "{{ site.google.gtag }}");
10
+ </script>
11
+ {%- endif -%}
@@ -0,0 +1,26 @@
1
+ {%- comment %} dns-prefetch {% endcomment %}
2
+ <link rel="dns-prefetch" href="https://cdn.jsdelivr.net">
3
+
4
+ {%- comment %} canonical link {% endcomment -%}
5
+ {%- if prev -%}
6
+ <link rel="prev" href="{{ prev.url | absolute_url }}">
7
+ {%- endif -%}
8
+
9
+ {%- if next -%}
10
+ <link rel="next" href="{{ next.url | absolute_url }}">
11
+ {%- endif -%}
12
+
13
+ <link rel="canonical" href="{{ schema_surl }}">
14
+
15
+ {%- comment %} favicon icon {% endcomment -%}
16
+ <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/assets/images/favicon.svg">
17
+ {%- comment %} alternate {% endcomment -%}
18
+ <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-16x16.png" sizes="16x16">
19
+ <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-32x32.png" sizes="32x32">
20
+ <link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-96x96.png" sizes="96x96">
21
+
22
+ {%- comment %} safari {% endcomment -%}
23
+ <link rel="mask-icon" href="{{ site.baseurl }}/assets/images/favicon.svg" color="{{ theme_color }}">
24
+
25
+ {%- comment %} apple-touch-icon {% endcomment -%}
26
+ <link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/images/apple-touch-icon-300x300.jpg">
@@ -0,0 +1,6 @@
1
+ {%- if page.content contains "$$" -%}
2
+ <script>
3
+ window.MathJax = {% if site.mathjax %}{{ site.mathjax | jsonify }}{% else %}{}{% endif %};
4
+ </script>
5
+ <script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax/es5/tex-svg-full.js"></script>
6
+ {%- endif %}
@@ -0,0 +1,10 @@
1
+ {%- if content contains '<code class="language-mermaid">' -%}
2
+ {%- if site.mermaid.custom -%}
3
+ <script src="{{ site.mermaid.custom }}"></script>
4
+ {%- else -%}
5
+ <script src="{{ base }}/assets/js/mermaid.min.js"></script>
6
+ {%- endif %}
7
+ <script>
8
+ mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
9
+ </script>
10
+ {%- endif %}
@@ -0,0 +1,12 @@
1
+ <meta charset="utf-8">
2
+ <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5, user-scalable=no">
3
+ <meta name="description" content="{{ description }}">
4
+ <meta name="revised" content="{{ docs.build_revision }}">
5
+ <meta name="author" content="{{ author }}">
6
+ <meta name="generator" content="{{ generator }} v{{ version }}">
7
+
8
+ {%- for meta in site.meta -%}
9
+ <meta name="{{ meta.first }}" content="{{ meta.last }}">
10
+ {%- endfor -%}
11
+
12
+ <meta name="theme-color" content="{{ theme_color }}">
@@ -0,0 +1,8 @@
1
+ <meta property="og:title" content="{{ title }}">
2
+ <meta property="og:description" content="{{ description }}">
3
+ <meta property="og:locale" content="{{ lang }}">
4
+ <meta property="og:url" content="{{ schema_surl }}">
5
+ <meta property="og:type" content="article">
6
+ <meta property="article:author" content="{{ author }}">
7
+ <meta property="article:published_time" content="{{ schema_date }}">
8
+ <meta property="article:modified_time" content="{{ schema_modi }}">
@@ -0,0 +1,6 @@
1
+ {%- assign content = content
2
+ | replace: "’", "'"
3
+ | replace: "“", '"'
4
+ | replace: "”", '"'
5
+ | replace: "<script", '<script async'
6
+ | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}
@@ -0,0 +1,7 @@
1
+ {%- include common/rest/site_pages.liquid -%}
2
+ {%- include common/rest/i18n.liquid -%}
3
+ {%- include common/rest/variables.liquid -%}
4
+ {%- include common/rest/content.liquid -%}
5
+ {%- include common/rest/nav.liquid -%}
6
+ {%- include common/rest/title.liquid -%}
7
+ {%- include common/rest/description.liquid -%}
@@ -0,0 +1,6 @@
1
+ {%- assign description = content
2
+ | strip_html
3
+ | split: " "
4
+ | join: " "
5
+ | escape
6
+ | truncate: 150 -%}
@@ -0,0 +1 @@
1
+ {%- assign __ = site.translate | default: site.data.translate -%}
@@ -0,0 +1,20 @@
1
+ {%- include common/rest/workdir.liquid workdir=page.dir -%}
2
+
3
+ {% comment %} prev and next {% endcomment %}
4
+ {%- assign index = 0 -%}
5
+ {%- for item in workdir_files %}
6
+ {%- if item.url == page.url %}
7
+ {%- assign index = forloop.index -%}
8
+ {%- endif %}
9
+ {%- endfor -%}
10
+
11
+ {%- for item in workdir_files -%}
12
+ {%- assign index_prev = index | minus: 1 -%}
13
+ {%- assign index_next = index | plus: 1 -%}
14
+ {%- if forloop.index == index_prev -%}
15
+ {%- assign prev = item -%}
16
+ {%- endif %}
17
+ {%- if forloop.index == index_next -%}
18
+ {%- assign next = item -%}
19
+ {%- endif %}
20
+ {%- endfor -%}
@@ -0,0 +1,8 @@
1
+ {%- assign site_pages = site.html_pages
2
+ | sort: "path"
3
+ | sort: "sort"
4
+ | where_exp: "item", "item.url != '/404.html'"
5
+ | where_exp: "item", "item.url != '/search.html'" -%}
6
+
7
+ {%- assign site_dirs = site_pages | where_exp: "item", "item.dir == item.url" -%}
8
+ {%- assign site_files = site_pages | where_exp: "item", "item.dir != item.url" -%}
@@ -0,0 +1,2 @@
1
+ {%- assign tab = " " -%}
2
+ {%- for temp in (1..include.size) %}{{ tab }}{% endfor -%}
@@ -0,0 +1,18 @@
1
+ {%- case page.url -%}
2
+ {%- when "/" -%}
3
+ {%- assign title = site.title
4
+ | append: " · "
5
+ | append: site.description | truncate: 110 -%}
6
+ {%- when "/search.html" -%}
7
+ {%- assign title = __.search | default: "Search"
8
+ | append: " · "
9
+ | append: site.title | truncate: 110 -%}
10
+ {%- when "/404.html" -%}
11
+ {%- assign title = "404"
12
+ | append: " · "
13
+ | append: site.title | truncate: 110 -%}
14
+ {%- else -%}
15
+ {%- assign title = page.title | default: page.name
16
+ | append: " · "
17
+ | append: site.title | truncate: 110 -%}
18
+ {%- endcase -%}
@@ -0,0 +1,41 @@
1
+ {%- comment %} variables {% endcomment -%}
2
+ {%- assign version = theme_alias | split: "@" | last -%}
3
+ {%- assign docs = site.github -%}
4
+ {%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
5
+
6
+ {%- assign rest_created_at = rest.created_at | default: site.time -%}
7
+ {%- assign rest_updated_at = rest.updated_at | default: site.time -%}
8
+
9
+ {%- comment %} defaults {% endcomment -%}
10
+ {%- assign direction = site.direction | default: "auto" -%}
11
+ {%- assign lang = site.lang | default: "en" -%}
12
+ {%- assign author = docs.owner.name | default: docs.owner_name -%}
13
+
14
+ {%- capture generator -%}
15
+ {%- if site.remote_theme -%}
16
+ {{- theme_alias | split: "@" | first -}}
17
+ {%- else -%}
18
+ {{- theme_alias | split: "@" | first | split: "/" | last -}}
19
+ {%- endif -%}
20
+ {%- endcapture -%}
21
+
22
+ {%- comment %} schema {% endcomment -%}
23
+ {%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
24
+ {%- assign schema_modi = site.time | date_to_xmlschema -%}
25
+ {%- assign schema_surl = page.url | absolute_url | xml_escape -%}
26
+
27
+ {% comment %} debug {% endcomment %}
28
+ {%- if site.debug -%}
29
+ {%- assign base = site.baseurl -%}
30
+ {%- else -%}
31
+ {%- assign base = "https://cdn.jsdelivr.net/gh/" | append: theme_alias -%}
32
+ {%- endif -%}
33
+
34
+ {% comment %} extra {% endcomment %}
35
+ {%- capture extra_scss -%}
36
+ {%- include extra/styles.scss -%} {{- site.scss -}}
37
+ {%- endcapture -%}
38
+
39
+ {%- capture extra_script -%}
40
+ {%- include extra/script.js -%} {{- site.script -}}
41
+ {%- endcapture -%}
@@ -0,0 +1,19 @@
1
+ {%- assign workdir = include.workdir | default: "/" -%}
2
+
3
+ {%- assign workdir_level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
4
+ {%- assign workdir_files = site_files | where_exp: "item", "item.dir == workdir" -%}
5
+
6
+ {%- capture items -%}
7
+ {%- for item in site_dirs -%}
8
+ {%- assign current_m1 = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 1 -%}
9
+ {%- if workdir_level == current_m1 -%}
10
+ {%- assign temp = workdir | append: "@@" -%}
11
+ {%- assign dir = item.dir | replace: workdir, temp | split: "@@" | first -%}
12
+ {% comment %} In the current subdirectory {% endcomment %}
13
+ {%- if workdir == dir -%}
14
+ {{ item.dir }}|
15
+ {%- endif -%}
16
+ {%- endif -%}
17
+ {%- endfor -%}
18
+ {%- endcapture -%}
19
+ {%- assign workdir_dirs = items | split: "|" -%}
@@ -0,0 +1,27 @@
1
+ <script type="application/ld+json">
2
+ {
3
+ "@context": "https://schema.org",
4
+ "@type": "Article",
5
+ "mainEntityOfPage": {
6
+ "@type": "WebPage",
7
+ "@id": "{{ schema_surl }}"
8
+ },
9
+ "headline": "{{ title }}",
10
+ "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
11
+ "author": {
12
+ "@type": "Person",
13
+ "name": "{{ author }}"
14
+ },
15
+ "datePublished": "{{ schema_date }}",
16
+ "dateModified": "{{ schema_modi }}",
17
+ "publisher": {
18
+ "@type": "{{ docs.owner.type }}",
19
+ "name": "{{ author }}",
20
+ "logo": {
21
+ "@type": "ImageObject",
22
+ "url": "{{ docs.owner.avatar_url }}"
23
+ }
24
+ },
25
+ "description": "{{ description }}"
26
+ }
27
+ </script>
@@ -0,0 +1,11 @@
1
+ <script>
2
+ window.ui = {
3
+ title: "{{ site.title }}",
4
+ baseurl: "{{ site.baseurl }}",
5
+ i18n: {
6
+ search_results: "{{ __.search_results | default: 'Search Results' }}",
7
+ search_results_found: "{{ __.search_results_found | default: 'Search finished, found # page(s) matching the search query.' }}",
8
+ search_results_not_found: "{{ __.search_results_not_found | default: 'Your search did not match any documents, please make sure that all characters are spelled correctly!' }}"
9
+ }
10
+ };
11
+ </script>
@@ -0,0 +1 @@
1
+ <title>{{ title }}</title>
@@ -0,0 +1,6 @@
1
+ <meta name="twitter:title" content="{{ title }}">
2
+ <meta name="twitter:description" content="{{ description }}">
3
+ <meta name="twitter:card" content="summary">
4
+ <meta name="twitter:site" content="@{{ author }}">
5
+ <meta name="twitter:url" content="{{ schema_surl }}">
6
+ <meta name="twitter:creator" content="@{{ generator }} v{{ version }}">
File without changes
File without changes
File without changes
File without changes
@@ -0,0 +1 @@
1
+ {%- include common/core/list.liquid -%}
@@ -0,0 +1,2 @@
1
+ {%- assign theme_alias = "rundocs/jekyll-rtd-theme@2.0.10" -%}
2
+ {%- assign theme_color = "#2980b9" -%}
@@ -0,0 +1,7 @@
1
+ <script src="{{ base }}/assets/js/jquery.min.js"></script>
2
+
3
+ {%- if extra_script.size > 0 -%}
4
+ <script>{{ extra_script }}</script>
5
+ {%- endif -%}
6
+
7
+ <script src="{{ base }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>
@@ -0,0 +1,5 @@
1
+ <link rel="stylesheet" href="{{ base }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
2
+
3
+ {%- if extra_scss.size > 0 -%}
4
+ <style>{{ extra_scss | scssify | strip_newlines }}</style>
5
+ {%- endif -%}
@@ -0,0 +1,9 @@
1
+ <div class="toasts danger mb-4">
2
+ <div class="title px-2 py-1">
3
+ <i class="fa fa-exclamation-triangle"></i>
4
+ {{ __.danger | default: "Danger" }}
5
+ </div>
6
+ <div class="content px-2 py-3">
7
+ {{ codes | markdownify | strip_newlines -}}
8
+ </div>
9
+ </div>
@@ -0,0 +1,3 @@
1
+ <div class="mermaid-wrap mb-4" data-lang="{{ codes | split: ' ' | first }}">
2
+ <div class="mermaid overflow-x-auto p-3">{{ codes }}</div>
3
+ </div>
@@ -0,0 +1,9 @@
1
+ <div class="toasts note mb-4">
2
+ <div class="title px-2 py-1">
3
+ <i class="fa fa-info-circle"></i>
4
+ {{ __.note | default: "Note" }}
5
+ </div>
6
+ <div class="content px-2 py-3">
7
+ {{ codes | markdownify | strip_newlines -}}
8
+ </div>
9
+ </div>
@@ -0,0 +1,9 @@
1
+ <div class="toasts tip mb-4">
2
+ <div class="title px-2 py-1">
3
+ <i class="fa fa-check-circle"></i>
4
+ {{ __.tip | default: "Tip" }}
5
+ </div>
6
+ <div class="content px-2 py-3">
7
+ {{ codes | markdownify | strip_newlines -}}
8
+ </div>
9
+ </div>
@@ -0,0 +1,9 @@
1
+ <div class="toasts warning mb-4">
2
+ <div class="title px-2 py-1">
3
+ <i class="fa fa-exclamation-circle"></i>
4
+ {{ __.warning | default: "Warning" }}
5
+ </div>
6
+ <div class="content px-2 py-3">
7
+ {{ codes | markdownify | strip_newlines -}}
8
+ </div>
9
+ </div>
@@ -0,0 +1,41 @@
1
+ {%- include common/rest/workdir.liquid %}
2
+
3
+ {% comment %} display the directory name {% endcomment %}
4
+ {%- assign dir = site_pages | where: "url", workdir | first -%}
5
+
6
+ {%- if workdir_level == 2 %}
7
+ {% comment %} display the root sub-directory as "p.caption" {% endcomment %}
8
+ <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="{{ dir.url | relative_url }}">
9
+ {{ dir.title | default: dir.url }}
10
+ </a>
11
+ {%- else %}
12
+ <a class="d-flex flex-items-baseline" href="{{ dir.url | relative_url }}">
13
+ {{ dir.title | default: dir.url }}
14
+ </a>
15
+ {%- endif -%}
16
+
17
+ <ul>
18
+ {% comment %} list file {% endcomment %}
19
+ {%- for item in workdir_files -%}
20
+ {%- assign level = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 1 -%}
21
+ {%- capture current -%}
22
+ {%- if page.url == item.url %}current{% endif -%}
23
+ {%- endcapture %}
24
+
25
+ <li class="toc level-{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
26
+ <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
27
+ {%- if item.sort -%}
28
+ {{ item.sort }}. {{ item.title | default: item.name }}
29
+ {%- else -%}
30
+ {{ item.title | default: item.name }}
31
+ {%- endif -%}
32
+ </a>
33
+ </li>
34
+ {%- endfor -%}
35
+
36
+ {% comment %} list dirs {% endcomment %}
37
+ {%- for workdir in workdir_dirs -%}
38
+ {%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
39
+ <li class="toc level-{{ level }}">{% include templates/_toctree.liquid %}</li>
40
+ {%- endfor -%}
41
+ </ul>