{"id":14979477,"url":"https://github.com/eccenca/jod","last_synced_at":"2025-06-26T09:07:05.141Z","repository":{"id":46818470,"uuid":"116140610","full_name":"eccenca/jod","owner":"eccenca","description":"The JOD project generates documentation web pages from Ontology turtle documents.","archived":false,"fork":false,"pushed_at":"2023-07-03T16:08:35.000Z","size":220,"stargazers_count":9,"open_issues_count":6,"forks_count":1,"subscribers_count":17,"default_branch":"develop","last_synced_at":"2025-06-01T06:50:10.207Z","etag":null,"topics":["documentation","jekyll","metadata","ontology"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eccenca.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2018-01-03T13:35:48.000Z","updated_at":"2023-01-04T20:49:12.000Z","dependencies_parsed_at":"2023-11-27T13:08:29.329Z","dependency_job_id":"a411cd3b-1a2f-48b2-8468-a9476afa511e","html_url":"https://github.com/eccenca/jod","commit_stats":{"total_commits":75,"total_committers":4,"mean_commits":18.75,"dds":0.6,"last_synced_commit":"f0cb475307efc22eb308961a02d41cb8404f71fe"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/eccenca/jod","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fjod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fjod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fjod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fjod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eccenca","download_url":"https://codeload.github.com/eccenca/jod/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eccenca%2Fjod/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262035180,"owners_count":23248357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","jekyll","metadata","ontology"],"created_at":"2024-09-24T14:00:06.223Z","updated_at":"2025-06-26T09:07:05.090Z","avatar_url":"https://github.com/eccenca.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JOD - Jekyll Ontology Documentation\n\nThe JOD project generates documentation web pages from Ontology turtle documents.\n\nJOD 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.\n\n## Status\n\nIn development as a proof of concept project at [eccenca](https://www.eccenca.com).\n\n\n## Installation\n\nAdd this line to your Jekyll site's `Gemfile`:\n\n```ruby\ngem \"jekyll-theme-jod\"\n```\n\nAnd add this line to your Jekyll site's `_config.yml`:\n\n```yaml\ntheme: jekyll-theme-jod\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install jekyll-theme-jod\n\n## Usage\n\nTODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.\n\n## Docker\n\nThere is also a docker container, that hides away all of the jekyll and jekyll-rdf specific configuration.\nIt currently is available at the GitHub Container Registry as `ghcr.io/eccenca/jod:main`.\n\nAs preparation your ontology should be available as `ontology.ttl` in the current directory.\nSpecify the base URL for the Jod documentation as `JOD_URL` (mandatory).\nYou can overwrite the ontologies title with `JOD_TITLE`.\nThe switch `JOD_RESTRICTION_URL` configures jod to only build resources with the configured base URL (this brings some speed up).\nTo 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).\n\n```\ndocker run --rm -v .:/data -e JOD_URL=http://example.org -e JOD_RESTRICTION_URL=True ghcr.io/eccenca/jod:main\n```\n\nWill produce a directory `_site` with the generated documentation.\n\n## Contributing\n\nBug 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.\n\n## Development\n\nTo set up your environment to develop this theme, run `bundle install`.\n\nYour theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.\n\nWhen your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). Take a look at the `LICENSE` file.\n\n## Screenshot\n\n![Screenshot](./Screenshot.png \"Screenshot\")\n\n## Related Projects\n\n- [Widoco](https://github.com/dgarijo/Widoco), a Wizard for documenting ontologies\n- [LODE](https://github.com/essepuntato/LODE), Live OWL Documentation Environment to convert OWL ontologies into HTML human-readable pages\n- [specgen](https://github.com/zazi/specgen) and other tools from the [Generating HTML documentation of OWL](https://www.w3.org/2011/prov/wiki/Generating_HTML_documentation_of_OWL) page\n- [OntoWiki's](http://ontowiki.net/) [site extension](https://github.com/AKSW/site.ontowiki), a HTML Content Publishing system on top of Linked Data\n- [Ontodocs](https://github.com/lambdamusic/Ontodocs), a Python command line application aimed at facilitating the creation of documentation for ontologies encoded in RDF/OWL.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feccenca%2Fjod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feccenca%2Fjod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feccenca%2Fjod/lists"}