Skip to content

Latest commit

 

History

History
53 lines (29 loc) · 2.98 KB

README.md

File metadata and controls

53 lines (29 loc) · 2.98 KB
Raw

o2r

This is the project website of the DFG-funded research project "Opening Reproducible Research" by Institute for Geoinformatics (ifgi) and University and Regional Library (ULB), University of Münster, Germany

The design is base on Hyde by Mark Otto.

Building the site

Follow the instructions for Poole to install the required software. Then run the site locally with

bundle exec jekyll serve

Use the --draft switch to preview the draft posts.

Site testing

Build Status

The page is tested in the context of a Travis CI build: https://travis-ci.org/o2r-project/o2r-project.github.io

This is based on the files .travis.yml and Gemfile.

Useful stuff

Images

We use the kramdown parser engine and subsequently can use some advanced syntax (e.g. for named lists, image resizing, quotes, and more).

To float images, use the CSS classes .img.leftfloat or .img.rightfloat, for example ![geocontainers logo](http://geocontainers.org/img/geocontainers-logo.png "geocontainers logo"){:width="100" .img.rightfloat}

Note: When the rendering engine is changed, these changes are prone to break.

Excerpts

The file index.html contains some logic trying to to a clever handling of the post excerpts, i.e. the texts that are shown in the listing of posts. The procedure is as follows:

  • If the disable_excerpt attribute is set to true, show the full content and do not show the "Read more" link. This is useful for short posts.
  • If the number of paragraphs in the post's excerpt is the same as the number of paragraphs of the post content, then see above. This is so that no "Read more" link is put on pages with no further text.
  • In any other case, show the excerpt and add a "Read more" link. You can set the length of the excerpt manually by using Jekyll's default tag <!--more-->.

Comments

We use DISQUS for comments, based on their Jekyll Installation Instructions, though not quite: Instead of enabling comments for each post, you must add disable_comments: true to the frontmatter to disable them explicitly. Data privacy issues are mentioned on the imprint page.

Ribbon

A generic "Fork me" ribbon has been added and can be configured (text, link) in the file _config.yml. The color is configured in public/css/o2r.css. The ribbon appears on all pages via _layouts/default.html, and stylesheets are included in _includes/head_default.html if enabled.

Exclude pages from menu

If you do not want a page to appear in the left hand side menu, include the parameter exclude_from_nav: true in the page's frontmatter.