These are the files necessary to develop, build and maintain e-editiones.ch - the website of the ontologies developed on GitHub in the repository Ontologies.
cd e-editiones
.bundle install
to fetch the needed Ruby gems.cd ttl_conv
.virtualenv env
source env/bin/activate
(type deactivate
to deactivate).pip3 install -r requirements.txt
to fetch the needed Python packages.cd ..
.You should now be all set to develop, build and maintain the website locally.
The folder and file structure you see is based on Jekyll's needs but there are some additional non-Jekyll folders and files. Below is a quick overview of the top-level files. You might want to visit the Jekyll Docs to see how Jekyll itself works.
Folder/File | Description |
---|---|
_includes | Jekyll folder containing HTML building blocks. The subfolder "ontologies" contains the human-readable HTML version of each ontology. |
_layouts | Jekyll folder containing HTML templates. |
_sass | Jekyll folder containing scss stylesheets. These files are compiled to a single css file for the final static website. |
_site | Jekyll folder containing the static files version of the website when serving locally. |
\docs | Custom Jekyll folder to save the built website files. |
assets | Jekyll folder containing asset files for the static website. |
collections | Jekyll folder to group content into collections. This folder is needed to group the created ontologies into "generic" and "project". |
ontology | Custom Jekyll folder containing all the ontology files. |
ttl_conv | Custom folder containing a Python script and additional resources to convert turtle files into needed formats and files. |
.gitignore | Gitingore file. |
404.html | 404 error page for the static website. |
_config.yml | Jekyll file for site-wide configurations. |
Gemfile | Ruby file used to list the needed Ruby Gems to run Jekyll. |
Gemfile.lock | Ruby file listing all the necessary Ruby Gem dependencies. |
index.md | Jekyll file with the content of the Home page. |
... .md | Jekyll files for specific pages. |
README.md | The very file you're reading right now. |
To serve the website locally, run bundle exec jekyll serve
and visit http://localhost:4000/e-editiones/.
To build the static website, run bundle exec jekyll build
and all necessary files will be available in the "\docs" folder.
To convert turtle files to the needed formats:
cd ttl_conv
.source env/bin/activate
.python3 -W ignore convert_files.py
.
-W ignore
is optional but it ignores some default RDFlib messages.bundle exec jekyll build
, which will generate static page files in the /docs directory.git add .
git commit -m "Deploy site to GitHub Pages"
(or whatever message suits your needs)git push
You might need to wait a few minutes to see any changes on the actual website.
To add a new ontology to the website, the following steps are necessary:
---
title: Petrus Lombard' Sentences
description: An ontology for the Digital Repertory of Commentaries on Peter Lombard’s Sentences
file: drcs
---
Everything written below the front matter will be shown on the ontology page as well.