jekyll-theme-open-hub 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/README.md +20 -5
- data/_layouts/spec.html +13 -6
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: af457b6c8b0855d8c0c7bdb74809481e0759dd554956e4f96ace0c173631c584
|
|
4
|
+
data.tar.gz: 6ba1a5544bb4f267930443ed284bd5499c7e2f2fcd50aea5097a536eb4e90ff5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 003d8c24282737eb622ef20b9da8c2a6fa77cb5294cd10a35f7057ad7faba3f055e19c0e7a120df1ae35669c60d404c78c5c93ceba1fd3b2386d635f0ec78e1e
|
|
7
|
+
data.tar.gz: ac7e6ae98638c1c5de3c5ab76614db831da42fe500b94032bfb58e3ec8dbfc376eb2ebe957c083243a8cc065080d5f984dff56918973001144bf60e27a2a6b75
|
data/README.md
CHANGED
|
@@ -326,6 +326,18 @@ of your open project’s Jekyll site.
|
|
|
326
326
|
Note: even though they’re in different subdirectories, all software products and specs
|
|
327
327
|
within one project share URL namespace and hence must have unique names.
|
|
328
328
|
|
|
329
|
+
YAML frontmatter that can be used with both software and specs:
|
|
330
|
+
|
|
331
|
+
```yaml
|
|
332
|
+
title: A Few Words
|
|
333
|
+
# Shown to the user
|
|
334
|
+
# and used for HTML metadata if jekyll-seo-tag is enabled
|
|
335
|
+
|
|
336
|
+
description: A sentence.
|
|
337
|
+
# Not necessarily shown to the user,
|
|
338
|
+
# but used for HTML metadata if jekyll-seo-tag is enabled
|
|
339
|
+
```
|
|
340
|
+
|
|
329
341
|
### Software product
|
|
330
342
|
|
|
331
343
|
YAML frontmatter specific to software:
|
|
@@ -333,6 +345,7 @@ YAML frontmatter specific to software:
|
|
|
333
345
|
```yaml
|
|
334
346
|
version: v1.2.3
|
|
335
347
|
docs_url: https://foobar.readthedocs.io/en/latest
|
|
348
|
+
repo_url: https://github.com/…
|
|
336
349
|
stack: [Python, Django, AWS]
|
|
337
350
|
```
|
|
338
351
|
|
|
@@ -363,6 +376,8 @@ ietf_datatracker_id: some-string-identifier-here
|
|
|
363
376
|
ietf_datatracker_ver: "01"
|
|
364
377
|
# IETF datatracker URL would be in the form
|
|
365
378
|
# https://datatracker.ietf.org/doc/<id>[-<version>]
|
|
379
|
+
|
|
380
|
+
source_url: https://example.com/spec-source-markup
|
|
366
381
|
```
|
|
367
382
|
|
|
368
383
|
Specs that are not hosted elsewhere (such as ietf.org for RFCs)
|
|
@@ -387,11 +402,11 @@ Place the symbol in _includes/symbol.svg within project directory.
|
|
|
387
402
|
|
|
388
403
|
## Content guidelines
|
|
389
404
|
|
|
390
|
-
- Project title: 1-3 words, capital case
|
|
391
|
-
- Project
|
|
392
|
-
- Project
|
|
393
|
-
-
|
|
394
|
-
-
|
|
405
|
+
- Project, software, spec title: 1-3 words, capital case
|
|
406
|
+
- Project, software, spec description: about 12 words, no markup
|
|
407
|
+
- Project description (featured): about 20-24 words, no markup
|
|
408
|
+
- Blog post title: 3–7 words
|
|
409
|
+
- Blog post excerpt: about 20–24 words, no markup
|
|
395
410
|
|
|
396
411
|
|
|
397
412
|
## Select layout reference
|
data/_layouts/spec.html
CHANGED
|
@@ -6,13 +6,20 @@ layout: default
|
|
|
6
6
|
<header>
|
|
7
7
|
<h1 class="title">{{ page.title }}</h1>
|
|
8
8
|
|
|
9
|
-
<p class="desc">{{ page.description }}</p>
|
|
10
|
-
|
|
11
9
|
<div class="meta">
|
|
12
|
-
{% if page.rfc_id %}
|
|
13
|
-
<
|
|
14
|
-
|
|
15
|
-
|
|
10
|
+
{% if page.rfc_id or page.ietf_datatracker_id or page.source_url %}
|
|
11
|
+
<ul>
|
|
12
|
+
{% if page.rfc_id %}
|
|
13
|
+
<li>
|
|
14
|
+
<a href="http://ietf.org/html/rfc{{ page.rfc_id }}">IETF RFC {{ page.rfc_id }}</a> {% endif %}
|
|
15
|
+
{% if page.ietf_datatracker_id %}
|
|
16
|
+
<li>
|
|
17
|
+
<a href="https://datatracker.ietf.org/doc/{{ page.ietf_datatracker_id }}{% if page.ietf_datatracker_ver %}-{{ page.ietf_datatracker_ver }}{% endif %}">IETF document</a> {% endif %}
|
|
18
|
+
{% if page.source_url %}
|
|
19
|
+
<li>
|
|
20
|
+
<a href="{{ page.source_url }}">Source markup</a> {% endif %}
|
|
21
|
+
</ul>
|
|
22
|
+
{% endif %}
|
|
16
23
|
</div>
|
|
17
24
|
</header>
|
|
18
25
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-open-hub
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ribose Inc.
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2018-05-
|
|
11
|
+
date: 2018-05-21 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: jekyll
|
|
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
169
169
|
version: '0'
|
|
170
170
|
requirements: []
|
|
171
171
|
rubyforge_project:
|
|
172
|
-
rubygems_version: 2.6
|
|
172
|
+
rubygems_version: 2.7.6
|
|
173
173
|
signing_key:
|
|
174
174
|
specification_version: 4
|
|
175
175
|
summary: Open Hub Jekyll theme
|