jekyll-theme-jod 0.2.6 → 0.3.2
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 +4 -4
- data/README.md +18 -1
- data/_includes/ontology-head.html +4 -0
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 674fd58c25ba6f4f91366b53c5254c785c2221cd34ebd8bbe2f70e3f7fcc01be
|
|
4
|
+
data.tar.gz: 76a2574eacfdb8f0c5ef4b64a4706f3c789b01ff456dd763ee50481b25055d66
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 64b3dd02b1d3ae95ee6ec21366be9be58c95a362af340c195d173346351359a707351f28fa3127ae7acea62b7d302573bff6ad7effe97dd87387bd8a630cc791
|
|
7
|
+
data.tar.gz: 8bbb4af7e5ed896cb6cf12e28cdca73cd85d9fd9bc148f2afd73439493479dfd8889a917371726307ab75a46134b076871845115309eeefb0e302314625c041e
|
data/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The JOD project generates documentation web pages from Ontology turtle documents.
|
|
4
4
|
|
|
5
|
-
JOD is based on [jekyll](jekyllrb.com) as well as the wonderful [jekyll-rdf plugin](https://github.com/
|
|
5
|
+
JOD is based on [jekyll](jekyllrb.com) as well as the wonderful [jekyll-rdf plugin](https://github.com/aksw/jekyll-rdf) and creates web pages which use [Bootstrap 4](https://getbootstrap.com/) as a front-end component library.
|
|
6
6
|
|
|
7
7
|
## Status
|
|
8
8
|
|
|
@@ -35,6 +35,23 @@ Or install it yourself as:
|
|
|
35
35
|
|
|
36
36
|
TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
|
|
37
37
|
|
|
38
|
+
## Docker
|
|
39
|
+
|
|
40
|
+
There is also a docker container, that hides away all of the jekyll and jekyll-rdf specific configuration.
|
|
41
|
+
It currently is available at the GitHub Container Registry as `ghcr.io/eccenca/jod:main`.
|
|
42
|
+
|
|
43
|
+
As preparation your ontology should be available as `ontology.ttl` in the current directory.
|
|
44
|
+
Specify the base URL for the Jod documentation as `JOD_URL` (mandatory).
|
|
45
|
+
You can overwrite the ontologies title with `JOD_TITLE`.
|
|
46
|
+
The switch `JOD_RESTRICTION_URL` configures jod to only build resources with the configured base URL (this brings some speed up).
|
|
47
|
+
To use your own configuration you can overwrite the docker run command, e.g. `jekyll build --disable-disk-cache --config _config.yml`. Checkout the [Jekyll RDF documentation for details](https://github.com/AKSW/jekyll-rdf).
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
docker run --rm -v .:/data -e JOD_URL=http://example.org -e JOD_RESTRICTION_URL=True ghcr.io/eccenca/jod:main
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Will produce a directory `_site` with the generated documentation.
|
|
54
|
+
|
|
38
55
|
## Contributing
|
|
39
56
|
|
|
40
57
|
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
@@ -56,6 +56,10 @@
|
|
|
56
56
|
<dt>Preferred Namespace URI</dt>
|
|
57
57
|
<dd>{{- vannPreferredNamespaceUri -}}</dd>
|
|
58
58
|
{%- endif -%}
|
|
59
|
+
{%- assign foafDepiction = page.rdf | rdf_property: 'foaf:depiction' -%}
|
|
60
|
+
{%- if foafDepiction -%}
|
|
61
|
+
<dd><img src="{{- foafDepiction -}}"/></dd>
|
|
62
|
+
{%- endif -%}
|
|
59
63
|
</dl>
|
|
60
64
|
</p>
|
|
61
65
|
<hr class="my-4">
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-theme-jod
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2
|
|
4
|
+
version: 0.3.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Sebastian Tramp
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2023-07-03 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: jekyll
|
|
@@ -31,14 +31,14 @@ dependencies:
|
|
|
31
31
|
requirements:
|
|
32
32
|
- - "~>"
|
|
33
33
|
- !ruby/object:Gem::Version
|
|
34
|
-
version: '
|
|
34
|
+
version: '4.0'
|
|
35
35
|
type: :runtime
|
|
36
36
|
prerelease: false
|
|
37
37
|
version_requirements: !ruby/object:Gem::Requirement
|
|
38
38
|
requirements:
|
|
39
39
|
- - "~>"
|
|
40
40
|
- !ruby/object:Gem::Version
|
|
41
|
-
version: '
|
|
41
|
+
version: '4.0'
|
|
42
42
|
- !ruby/object:Gem::Dependency
|
|
43
43
|
name: liquid-md5
|
|
44
44
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -87,14 +87,14 @@ dependencies:
|
|
|
87
87
|
requirements:
|
|
88
88
|
- - "~>"
|
|
89
89
|
- !ruby/object:Gem::Version
|
|
90
|
-
version: '
|
|
90
|
+
version: '13'
|
|
91
91
|
type: :development
|
|
92
92
|
prerelease: false
|
|
93
93
|
version_requirements: !ruby/object:Gem::Requirement
|
|
94
94
|
requirements:
|
|
95
95
|
- - "~>"
|
|
96
96
|
- !ruby/object:Gem::Version
|
|
97
|
-
version: '
|
|
97
|
+
version: '13'
|
|
98
98
|
description:
|
|
99
99
|
email:
|
|
100
100
|
- sebastian.tramp@eccenca.com
|
|
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
135
135
|
- !ruby/object:Gem::Version
|
|
136
136
|
version: '0'
|
|
137
137
|
requirements: []
|
|
138
|
-
rubygems_version: 3.
|
|
138
|
+
rubygems_version: 3.4.10
|
|
139
139
|
signing_key:
|
|
140
140
|
specification_version: 4
|
|
141
141
|
summary: The JOD theme generates documentation web pages from Ontology turtle documents
|