jekyll-theme-jod 0.2.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d050f5917b35c2445ceff40f6e70c79216c565f72176b32d09c37b9f69e2b4e
-  data.tar.gz: 7cc760314d908c273ef4fb64ce988ca76024c2d4879894d8ba7d7870d6aa5715
+  metadata.gz: 674fd58c25ba6f4f91366b53c5254c785c2221cd34ebd8bbe2f70e3f7fcc01be
+  data.tar.gz: 76a2574eacfdb8f0c5ef4b64a4706f3c789b01ff456dd763ee50481b25055d66
 SHA512:
-  metadata.gz: 064e6a8aa7a1edb8a182c0f095ddfa0875499069902b8c36012b3cf9d943f81302b2debf988b1f931545669ccb0ffbcf975a8fc1e71c42fc12b836145b9a7338
-  data.tar.gz: b3d68c53c31ce737380168683c52d23c792803b10d48c1abe7c11f8c83d02716d5652210af1a41fd8d796c0712b8f6be423588946768bf26964456b7d93336bb
+  metadata.gz: 64b3dd02b1d3ae95ee6ec21366be9be58c95a362af340c195d173346351359a707351f28fa3127ae7acea62b7d302573bff6ad7effe97dd87387bd8a630cc791
+  data.tar.gz: 8bbb4af7e5ed896cb6cf12e28cdca73cd85d9fd9bc148f2afd73439493479dfd8889a917371726307ab75a46134b076871845115309eeefb0e302314625c041e

data/README.md

@@ -2,7 +2,7 @@
 
 The JOD project generates documentation web pages from Ontology turtle documents.
 
-JOD is based on [jekyll](jekyllrb.com) as well as the wonderful [jekyll-rdf plugin](https://github.com/white-gecko/jekyll-rdf) and creates web pages which use [Bootstrap 4](https://getbootstrap.com/) as a front-end component library.
+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.
 
 ## Status
 
@@ -35,6 +35,23 @@ Or install it yourself as:
 
 TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
 
+## Docker
+
+There is also a docker container, that hides away all of the jekyll and jekyll-rdf specific configuration.
+It currently is available at the GitHub Container Registry as `ghcr.io/eccenca/jod:main`.
+
+As preparation your ontology should be available as `ontology.ttl` in the current directory.
+Specify the base URL for the Jod documentation as `JOD_URL` (mandatory).
+You can overwrite the ontologies title with `JOD_TITLE`.
+The switch `JOD_RESTRICTION_URL` configures jod to only build resources with the configured base URL (this brings some speed up).
+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).
+
+```
+docker run --rm -v .:/data -e JOD_URL=http://example.org -e JOD_RESTRICTION_URL=True ghcr.io/eccenca/jod:main
+```
+
+Will produce a directory `_site` with the generated documentation.
+
 ## Contributing
 
 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.

data/_config.yml

@@ -0,0 +1,11 @@
+baseurl: "/" # the subpath of your site, e.g. /blog
+url: "http://example.org" # the base hostname & protocol for your site, e.g. http://example.com
+
+theme: jekyll-theme-jod
+
+jekyll_rdf:
+    path: "ontology.ttl"
+    include_blank: false
+    default_template: "resource.html"
+    class_template_mappings:
+      "http://www.w3.org/2002/07/owl#Ontology": "ontology.html"

data/_includes/ontology-head.html

@@ -1,5 +1,13 @@
 <div class="jumbotron">
-  <h1 class="display-3">{% include label.html iri = page.rdf.iri %}</h1>
+  {% assign site_title_config = site.title | strip %}
+  {% if site_title_config != "" %}
+  {% assign site_title = site.title %}
+  {% else %}
+  {% capture site_title -%}
+  {% include label.html iri = page.rdf.iri %}
+  {%- endcapture %}
+  {% endif %}
+  <h1 class="display-3">{{ site_title }}</h1>
   <p class="lead subtitle">{{ page.rdf | rdf_property: 'dbo:subtitle', 'en' }}</p>
   <p class="lead">{{ page.rdf | rdf_property: 'rdfs:comment', 'en' }}</p>
   <hr class="my-4">
@@ -48,6 +56,10 @@
         <dt>Preferred Namespace URI</dt>
         <dd>{{- vannPreferredNamespaceUri -}}</dd>
         {%- endif -%}
+        {%- assign foafDepiction = page.rdf | rdf_property: 'foaf:depiction' -%}
+        {%- if foafDepiction -%}
+        <dd><img src="{{- foafDepiction -}}"/></dd>
+        {%- endif -%}
     </dl>
   </p>
   <hr class="my-4">

data/_layouts/default.html

@@ -1,7 +1,15 @@
 <!doctype html>
 <html lang="en">
   <head>
-    <title>{{ site.title }}</title>
+    {% assign site_title_config = site.title | strip %}
+    {% if site_title_config != "" %}
+    {% assign site_title = site.title %}
+    {% else %}
+    {% capture site_title -%}
+    {% include label.html iri = page.rdf.iri %}
+    {%- endcapture %}
+    {% endif %}
+    <title>{{ site_title }}</title>
     <!-- Required meta tags -->
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-jod
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.2
 platform: ruby
 authors:
 - Sebastian Tramp
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: jekyll-rdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: liquid-md5
   requirement: !ruby/object:Gem::Requirement
@@ -53,34 +53,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 description:
 email:
 - sebastian.tramp@eccenca.com
@@ -91,6 +105,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- _config.yml
 - _data/prefixes.pref
 - _includes/class-card.html
 - _includes/internal-link.html
@@ -120,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The JOD theme generates documentation web pages from Ontology turtle documents