jekyll-theme-open-project 2.1.10 → 2.1.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +41 -7
- data/_layouts/default.html +4 -1
- data/_sass/jekyll-theme-open-project.scss +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 11678ab83694605f8e208bb9f2e0ed2aacb335313f7e2d67e02e3d285b756643
|
4
|
+
data.tar.gz: a3fb8118e5df1eb9e7e23f1b19054b8dfe847d3efae96377762a831b3e004690
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 233efaa726d223d8e3ce6ab6e4d94c8350e2e3078da2f6d2d292b754dae63a742e9241c75fd06a03b54dfdc94cc753161fa3d5a84c0325a1589d3fbf81a778d6
|
7
|
+
data.tar.gz: ce5343194c2b4488971a4ac99ee343a19bdb35ec9880538ed414727c26f2d241b22cd8b0c7d8fa6b910c856119bccc5713394f0f71fc53d1b4715937cda978a0
|
data/README.md
CHANGED
@@ -140,6 +140,33 @@ There are 3 areas to configure when you first create an Open Site, namely:
|
|
140
140
|
|
141
141
|
## Common setup
|
142
142
|
|
143
|
+
### Git repository branch behavior
|
144
|
+
|
145
|
+
You’ll see many instances of document frontmatter
|
146
|
+
referencing Git repository URLs.
|
147
|
+
|
148
|
+
Note that, wherever a `[*_]repo_url` property is encountered,
|
149
|
+
a sibling property `[*_]repo_branch` is supported.
|
150
|
+
(This is new in 2.1.17, until that version branch “master” was used for all repositories.)
|
151
|
+
|
152
|
+
If you reference repositories that don’t use branch name “main”,
|
153
|
+
you must either:
|
154
|
+
|
155
|
+
- use a sibling `[*_]repo_branch` property to specify your custom branch name
|
156
|
+
(you can search for `git_repo_branch`, `repo_branch`, `github_repo_branch`
|
157
|
+
in this document for examples), or
|
158
|
+
|
159
|
+
- specify `default_repo_branch` property in `config.yml`
|
160
|
+
|
161
|
+
(in this case, in scenarios with project sites being used in conjunction
|
162
|
+
with a hub site, `default_repo_branch` must be the same
|
163
|
+
across all project sites’ and their hub site’s `config.yml`—otherwise you’re advised
|
164
|
+
to use the previous option to avoid site build failure).
|
165
|
+
|
166
|
+
Note that, when a referenced Git repository doesn’t contain the necessary branch
|
167
|
+
(either explicitly specified custom branch, or `default_repo_branch`, or branch called “main”),
|
168
|
+
this will cause build failure of that project site, or a hub site using that project site.
|
169
|
+
|
143
170
|
### Common settings
|
144
171
|
|
145
172
|
(mandatory)
|
@@ -175,10 +202,10 @@ These settings apply to both site types (hub and project).
|
|
175
202
|
|
176
203
|
default_repo_branch: main
|
177
204
|
# Optional, default is `main`.
|
178
|
-
# Whenever
|
179
|
-
# (such as project docs or specs), this name will be used
|
180
|
-
#
|
181
|
-
#
|
205
|
+
# Whenever branch name isn’t specified for some repository
|
206
|
+
# (such as project docs or specs), this name will be used
|
207
|
+
# during site’s build.
|
208
|
+
# (See branch behavior section for details.)
|
182
209
|
|
183
210
|
tagline: Because examples are very important
|
184
211
|
# Used in hero unit on main page.
|
@@ -201,7 +228,13 @@ These settings apply to both site types (hub and project).
|
|
201
228
|
# Without this setting, one-file FA distribution, all.js, is included from free FA CDN.
|
202
229
|
|
203
230
|
theme: jekyll-theme-open-project
|
204
|
-
|
231
|
+
|
232
|
+
permalink: /blog/:month-:day-:year-:title/
|
233
|
+
# It’s important that dash-separated permalink is used for blog posts.
|
234
|
+
# There’re no daily or monthly blog archive pages generated.
|
235
|
+
# Hub sites reference posts using that method, and it’s currently non-customizable.
|
236
|
+
# With `collections` configuration, specify permalink for posts
|
237
|
+
# correctly as well (for an example, see https://github.com/metanorma/metanorma.org/blob/d2b15f6d8c4cea73d45ad899374845ec38348ff1/_config.yml#L60).
|
205
238
|
```
|
206
239
|
|
207
240
|
### Logo
|
@@ -307,12 +340,13 @@ For project posts, see below the project site section.
|
|
307
340
|
|
308
341
|
The hub represents your company or department, links to all projects
|
309
342
|
and offers a software and specification index.
|
343
|
+
|
344
|
+
Note that a hub site is expected to have at least one document
|
345
|
+
in the `projects` collection (see below).
|
310
346
|
|
311
347
|
Additional items allowed/expected in _config.yml:
|
312
348
|
|
313
349
|
```yaml
|
314
|
-
is_hub: true
|
315
|
-
|
316
350
|
# Since a hub would typically represent an organization as opposed
|
317
351
|
# to individual, this would make sense:
|
318
352
|
seo:
|
data/_layouts/default.html
CHANGED
@@ -93,8 +93,11 @@
|
|
93
93
|
|
94
94
|
<div class="underlay footer">
|
95
95
|
<footer>
|
96
|
-
{% if site.num_all_specs > 0 or site.num_all_software > 0 %}
|
96
|
+
{% if site.num_all_specs > 0 or site.num_all_software > 0 or site.extra_footer_links %}
|
97
97
|
<nav class="links" aria-label="site links">
|
98
|
+
{% for link in site.extra_footer_links %}
|
99
|
+
<a href="{{ link.url }}">{{ link.title }}</a>
|
100
|
+
{% endfor %}
|
98
101
|
{% if site.num_all_software > 0 %}
|
99
102
|
<a href="/software/">All {{ site.title }} software</a>
|
100
103
|
{% endif %}
|
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.1.
|
4
|
+
version: 2.1.12
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ribose Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-04-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: jekyll
|
@@ -240,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
240
240
|
- !ruby/object:Gem::Version
|
241
241
|
version: '0'
|
242
242
|
requirements: []
|
243
|
-
rubygems_version: 3.
|
243
|
+
rubygems_version: 3.3.7
|
244
244
|
signing_key:
|
245
245
|
specification_version: 4
|
246
246
|
summary: Open Project Jekyll theme
|