jekyll-theme-open-project 2.0.1 → 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +18 -14
- data/_config.yml +10 -0
- data/_includes/external-link.html +4 -4
- data/_includes/head.html +0 -0
- data/_includes/home-hero.html +1 -1
- data/_includes/item-doc-page.html +3 -3
- data/_layouts/default.html +16 -7
- data/_layouts/docs-base.html +2 -2
- data/_sass/jekyll-theme-open-project.scss +4 -0
- data/_sass/open-project-mixins.scss +10 -5
- metadata +5 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aff4ab4e845908430012fb65710082e1abc2fd21
|
4
|
+
data.tar.gz: 30e4171d77ea0c8c3728c7d45d3212b8ddaaf782
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b13b325eb8e0781ddce197c3f55f9639ed8b0923fb3ef3570350e86e71e02a6b12274d6fbe650f28e04ab17f78f4067a75889f457f66e5936a593aaf43bec9ac
|
7
|
+
data.tar.gz: b9722b7db51576cbe2e74bc61983fd891e70fc80d0648d67a04615bbf651b988514c6b96e115071412cbf476ac2e2ae33aae8285a2c8cc53f06e94d91ae7b6f9
|
data/README.md
CHANGED
@@ -112,14 +112,13 @@ These settings apply to both site types (hub and project).
|
|
112
112
|
# Site’s URL with protocol and without optional www. prefix.
|
113
113
|
# Used e.g. for marking external links in docs and blog posts.
|
114
114
|
|
115
|
-
title:
|
116
|
-
description:
|
115
|
+
title: Example
|
116
|
+
description: The example of examples
|
117
117
|
# The above two are used by jekyll-seo-tag for things such as
|
118
118
|
# `<title>` and `<meta>` tags, as well as elsewhere by the theme.
|
119
119
|
|
120
|
-
tagline:
|
121
|
-
|
122
|
-
# The above two are used in home hero unit.
|
120
|
+
tagline: Because examples are very important
|
121
|
+
# Used in hero unit on main page.
|
123
122
|
|
124
123
|
social:
|
125
124
|
links:
|
@@ -131,7 +130,12 @@ These settings apply to both site types (hub and project).
|
|
131
130
|
tos_link: https://www.example.com/tos
|
132
131
|
privacy_policy_link: https://www.example.com/privacy
|
133
132
|
|
134
|
-
#
|
133
|
+
# no_auto_fontawesome: yes
|
134
|
+
# Specify this only if you want to disable free Font Awesome CDN.
|
135
|
+
# IMPORTANT: In this case your site MUST specify include head.html with appropriate scripts.
|
136
|
+
# Theme design relies on Font Awesome “solid” and “brands” icon styles
|
137
|
+
# and expects them to be included in SVG mode.
|
138
|
+
# Without this setting, one-file FA distribution, all.js, is included from free FA CDN.
|
135
139
|
|
136
140
|
theme: jekyll-theme-open-project
|
137
141
|
permalink: /blog/:month-:day-:year/:title/
|
@@ -154,10 +158,10 @@ and name as word(s).
|
|
154
158
|
Drop a file called `title.html` in the root of your site.
|
155
159
|
In its contents you can go as simple as `{{ site.name }}`
|
156
160
|
and as complex as a custom SVG shape.
|
157
|
-
|
161
|
+
|
158
162
|
Note that it must look good when placed inside ~30px tall container.
|
159
163
|
In case of SVG, SVG guidelines apply.
|
160
|
-
|
164
|
+
|
161
165
|
Do not create custom CSS rules for .site-logo descendants:
|
162
166
|
this may cause issues when one site’s logo is used in context of another site
|
163
167
|
of the same hub. You can use inline styling, though.
|
@@ -255,9 +259,8 @@ must contain a file "index.md" with frontmatter like this:
|
|
255
259
|
|
256
260
|
```yaml
|
257
261
|
title: Sample Awesome Project
|
258
|
-
|
259
|
-
|
260
|
-
A sentence or two go here.
|
262
|
+
description: A sentence or two about what the project is for.
|
263
|
+
tagline: Because awesomeness is underrated
|
261
264
|
|
262
265
|
# Whether the project is included in featured three projects on hub home page
|
263
266
|
featured: true | false
|
@@ -346,6 +349,7 @@ parent_hub:
|
|
346
349
|
algolia_search:
|
347
350
|
api_key: '<your Algolia API key>'
|
348
351
|
index_name: '<your Algolia index name>'
|
352
|
+
|
349
353
|
# Only add this if you want to use Algolia’s search on your project site.
|
350
354
|
|
351
355
|
tag_namespaces:
|
@@ -508,7 +512,7 @@ external_links:
|
|
508
512
|
# GitHub, Docs.rs, RubyDoc,
|
509
513
|
# ietf.org/html/rfcN, datatracker.ietf.org/doc/…
|
510
514
|
# * Order links according to importance for project site visitors.
|
511
|
-
# The first link will be highlighted as primary.
|
515
|
+
# The first link will be highlighted as primary.
|
512
516
|
|
513
517
|
feature_with_priority: 1
|
514
518
|
# With this key, software or spec will be featured on home
|
@@ -695,7 +699,7 @@ Commonly used layouts are:
|
|
695
699
|
|
696
700
|
### Page frontmatter
|
697
701
|
|
698
|
-
Typical expected page frontmatter is `title` and `description`. Those are
|
702
|
+
Typical expected page frontmatter is `title` and `description`. Those are
|
699
703
|
also used by jekyll-seo-tag plugin to add the appropriate meta tags.
|
700
704
|
|
701
705
|
Commonly supported in page frontmatter is the hero_include option,
|
@@ -817,7 +821,7 @@ run `bundle install`.
|
|
817
821
|
|
818
822
|
To experiment with this code, add content (projects, software, specs)
|
819
823
|
and run `bundle exec jekyll serve`. This starts a Jekyll server
|
820
|
-
using this theme at `http://localhost:4000`.
|
824
|
+
using this theme at `http://localhost:4000`.
|
821
825
|
|
822
826
|
Put your layouts in `_layouts`, your includes in `_includes`,
|
823
827
|
your sass files in `_sass` and any other assets in `assets`.
|
data/_config.yml
CHANGED
@@ -41,6 +41,16 @@ collections:
|
|
41
41
|
output: true
|
42
42
|
permalink: /:name/
|
43
43
|
|
44
|
+
fontawesome_cdn:
|
45
|
+
version: v5.8.1
|
46
|
+
integrity: "sha384-g5uSoOSBd7KkhAMlnQILrecXvzst9TdC09/VM+pjDTCM+1il8RHz5fKANTFFb+gQ"
|
47
|
+
# Only applies if no_auto_fontawesome is not set.
|
48
|
+
|
49
|
+
no_auto_fontawesome: false
|
50
|
+
# If set to yes, site (with default design) must specify <script> elements
|
51
|
+
# that make required FA styles available in SVG mode.
|
52
|
+
|
53
|
+
|
44
54
|
defaults:
|
45
55
|
- scope:
|
46
56
|
path: ""
|
@@ -10,7 +10,7 @@
|
|
10
10
|
|
11
11
|
{% elsif include.url contains "rubygems.org" %}
|
12
12
|
<span class="ico">
|
13
|
-
<i class="
|
13
|
+
<i class="fas fa-gem"></i>
|
14
14
|
</span>
|
15
15
|
<span class="lbl">
|
16
16
|
{{ include.title | default: "Gem" }}
|
@@ -18,7 +18,7 @@
|
|
18
18
|
|
19
19
|
{% elsif include.url contains "crates.io/crates" %}
|
20
20
|
<span class="ico">
|
21
|
-
<i class="
|
21
|
+
<i class="fas fa-cubes"></i>
|
22
22
|
</span>
|
23
23
|
<span class="lbl">
|
24
24
|
{{ include.title | default: "Crate" }}
|
@@ -26,7 +26,7 @@
|
|
26
26
|
|
27
27
|
{% elsif include.url contains "rubydoc" %}
|
28
28
|
<span class="ico">
|
29
|
-
<i class="
|
29
|
+
<i class="fas fa-gem"></i>
|
30
30
|
</span>
|
31
31
|
<span class="lbl">
|
32
32
|
{{ include.title | default: "RubyDoc" }}
|
@@ -34,7 +34,7 @@
|
|
34
34
|
|
35
35
|
{% elsif include.url contains "docs.rs" %}
|
36
36
|
<span class="ico">
|
37
|
-
<i class="
|
37
|
+
<i class="fas fa-book"></i>
|
38
38
|
</span>
|
39
39
|
<span class="lbl">
|
40
40
|
{{ include.title | default: "Docs.rs" }}
|
data/_includes/head.html
ADDED
File without changes
|
data/_includes/home-hero.html
CHANGED
@@ -47,8 +47,8 @@ supporting expandable navigation widget.
|
|
47
47
|
|
48
48
|
{% if num_top_nav_items > 0 %}
|
49
49
|
<span class="nav-toggle-icon">
|
50
|
-
<i class="open
|
51
|
-
<i class="close
|
50
|
+
<i class="open fas fa-ellipsis-v"></i>
|
51
|
+
<i class="close fas fa-times"></i>
|
52
52
|
</span>
|
53
53
|
{% endif %}
|
54
54
|
</div>
|
@@ -66,7 +66,7 @@ supporting expandable navigation widget.
|
|
66
66
|
<li class="item home-link" title="Documentation index">
|
67
67
|
<a href="{{ product_base_url | relative_url }}">
|
68
68
|
<span class="ico">
|
69
|
-
<i class="
|
69
|
+
<i class="fas fa-home"></i>
|
70
70
|
</span>
|
71
71
|
<span class="lbl">
|
72
72
|
Home
|
data/_layouts/default.html
CHANGED
@@ -9,7 +9,14 @@
|
|
9
9
|
<link href="{{ "/assets/webclip.png" | relative_url }}" rel="apple-touch-icon">
|
10
10
|
|
11
11
|
<link id="themeCSS" rel="stylesheet" href="{{ "assets/css/style.css" | relative_url }}">
|
12
|
-
|
12
|
+
|
13
|
+
{% unless site.no_auto_fontawesome %}
|
14
|
+
<script
|
15
|
+
defer
|
16
|
+
src="https://use.fontawesome.com/releases/{{ site.fontawesome_cdn.version }}/js/all.js"
|
17
|
+
integrity="{{ site.fontawesome_cdn.integrity }}"
|
18
|
+
crossorigin="anonymous"></script>
|
19
|
+
{% endunless %}
|
13
20
|
|
14
21
|
{% if site.algolia_search %}
|
15
22
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
|
@@ -28,6 +35,8 @@
|
|
28
35
|
{% endif %}
|
29
36
|
|
30
37
|
{% seo %}
|
38
|
+
|
39
|
+
{% include head.html %}
|
31
40
|
</head>
|
32
41
|
|
33
42
|
{% assign num_projects = site.projects | size %}
|
@@ -99,14 +108,14 @@
|
|
99
108
|
{% endcomment %}
|
100
109
|
<script>
|
101
110
|
window.initAlgolia = function () {
|
102
|
-
docsearch({
|
103
|
-
apiKey: '{{ site.algolia_search.api_key }}',
|
104
|
-
indexName: '{{ site.algolia_search.index_name }}',
|
105
|
-
inputSelector: 'input[type=search]',
|
111
|
+
docsearch({
|
112
|
+
apiKey: '{{ site.algolia_search.api_key }}',
|
113
|
+
indexName: '{{ site.algolia_search.index_name }}',
|
114
|
+
inputSelector: 'input[type=search]',
|
106
115
|
debug: false,
|
107
|
-
});
|
116
|
+
});
|
108
117
|
};
|
109
|
-
</script>
|
118
|
+
</script>
|
110
119
|
{% endif %}
|
111
120
|
|
112
121
|
<script src="{{ "assets/js/headroom.min.js" | relative_url }}"></script>
|
data/_layouts/docs-base.html
CHANGED
@@ -24,8 +24,8 @@ layout: default
|
|
24
24
|
|
25
25
|
{% if num_top_nav_items > 0 %}
|
26
26
|
<span class="nav-toggle-icon">
|
27
|
-
<i class="open
|
28
|
-
<i class="close
|
27
|
+
<i class="open fas fa-ellipsis-v"></i>
|
28
|
+
<i class="close fas fa-times"></i>
|
29
29
|
</span>
|
30
30
|
{% endif %}
|
31
31
|
</div>
|
@@ -1,4 +1,7 @@
|
|
1
|
+
@import url('https://fonts.googleapis.com/css?family=Inconsolata');
|
2
|
+
|
1
3
|
$font-family: Helvetica, Arial, sans-serif !default;
|
4
|
+
$font-family-source: Inconsolata, monospace;
|
2
5
|
|
3
6
|
$main-font-color: #000;
|
4
7
|
|
@@ -653,6 +656,7 @@ body.site--project {
|
|
653
656
|
display: flex;
|
654
657
|
flex-flow: row nowrap;
|
655
658
|
align-items: center;
|
659
|
+
flex-shrink: 0;
|
656
660
|
|
657
661
|
.title {
|
658
662
|
flex: 1;
|
@@ -25,14 +25,17 @@
|
|
25
25
|
}
|
26
26
|
|
27
27
|
@mixin padded-code-snippet() {
|
28
|
-
padding:
|
28
|
+
padding: .2em .5em;
|
29
29
|
margin: 0 .2em;
|
30
|
-
background: $code-listing-background-color;
|
31
|
-
|
32
|
-
border: 1px dashed $code-listing-border-color;
|
33
|
-
border-radius: .25em;
|
34
30
|
|
35
31
|
font-size: 15px;
|
32
|
+
|
33
|
+
background: $code-listing-background-color;
|
34
|
+
|
35
|
+
border-color: $code-listing-border-color;
|
36
|
+
border-width: 0 1px 0 1px;
|
37
|
+
border-style: dashed;
|
38
|
+
border-radius: 0;
|
36
39
|
}
|
37
40
|
|
38
41
|
@mixin padded-code-snippet--reset() {
|
@@ -74,6 +77,8 @@
|
|
74
77
|
margin-top: -1px;
|
75
78
|
margin-bottom: -1px;
|
76
79
|
|
80
|
+
font-family: $font-family-source;
|
81
|
+
|
77
82
|
code {
|
78
83
|
// Avoid bad formatting in case of <code> elements nested
|
79
84
|
// into each other (possible with adoc output)
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: jekyll-theme-open-project
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 2.0.
|
4
|
+
version: 2.0.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ribose Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-05-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -72,14 +72,14 @@ dependencies:
|
|
72
72
|
requirements:
|
73
73
|
- - '='
|
74
74
|
- !ruby/object:Gem::Version
|
75
|
-
version: 2.0.
|
75
|
+
version: 2.0.2
|
76
76
|
type: :runtime
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
80
|
- - '='
|
81
81
|
- !ruby/object:Gem::Version
|
82
|
-
version: 2.0.
|
82
|
+
version: 2.0.2
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
84
|
name: bundler
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
@@ -165,6 +165,7 @@ files:
|
|
165
165
|
- _includes/featured_posts.html
|
166
166
|
- _includes/featured_software.html
|
167
167
|
- _includes/featured_specs.html
|
168
|
+
- _includes/head.html
|
168
169
|
- _includes/home-hero.html
|
169
170
|
- _includes/home-hub.html
|
170
171
|
- _includes/home-project.html
|