Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
122 lines (91 sloc) 5.52 KB

Digital Edition Jekyll Theme

digitaledition-jekylltheme is a Jekyll theme based on Lanyon. It is intended to be used with Readux and teifacsimile-to-jekyll to display an annotated digital edition.

Contents

Usage

Create your annotations on Readux, export your volume as a Jekyll site, and start Jekyll to see your annotated digital edition.

See the Poole usage guidelines or the Jekyll documentation for instructions on installing and using Jekyll.

Content

This digital edition Jekyll site makes use of Jekyll Collections to display non-blog content. When you create a site via Readux or import annotated TEI facsimile using teifacsmile-to-jekyll, your site will include the following:

  • a volume_pages collection, with content in the _volume_pages directory
    • one html file per page in the volume, with files numbered sequentially
  • an annotation collection, with content in the _annotations directory
    • one markdown file per annotation; files are numbered by annotation id
  • a tag data file in _data/tags.yml with the tags from your annotations
  • one markdown page per tag in the tags directory, for simple access to annotations by tag

The base Jekyll theme also includes placeholder introduction and credits pages, which you can edit to content to your annotated digital edition. Additional pages can be added in a similar fashion.

Note that Jekyll is generally thought of as a blogging platform. That functionality is still available here, of course, but in a somewhat suppressed fashion. If you want to add blog posts to your digital edition, feel free to do so. You will have to determine how and where to integrate them into the site, since they are not curently included.

Options

This Jekyll project includes several options for customization.

Lanyon

All display customizations available in Lanyon are available, including configurable theme and various sidebar display options. See the Lanyon documentation for specifics.

Sidebar Menu

This Jekyll project revises the default Lanyon sidebar logic, which automatically displays all top-level pages alphabetically. To include a page in the sidebar navigation, and to control the order, set a nav_order number in the front matter of the page you want included.

Show an open sidebar on page load by modifying the <input> tag within the sidebar.html layout to add the checked boolean attribute:

Custom Page URLs

The Readux web export and the teifacsimile-to-jekyll script allow you to optionally specify which page in the Readux volume is numbered 1 in the original edition, as a convenience to generate a site with nicer urls. All of the pages before your designated page 1 will be numbered and displayed with the label "Front", but these can be customized. To override page urls, edit the front matter for each page that you want customized and modify the following fields as desired:

  • title: used as the label displayed on the individual page, in the HTML header, and as previews for next and previous page links
  • short_label: customize the short label prefix used on thumbnail display (default for normal pages is p.)
  • number: number to be displayed with the short label on thumbnail views
  • permalink: custom url for this page; note that these should always start with /pages/ and must have a unique value.

Search

Currently, search is implemented using Elasticlunr.js, a JavaScript-based search engine that does not require any extra Jekyll plugins, and provide more advanced features than Lunr.js, which is what Elasticlunr.js is based on. There are also changes to the UI so that the search is more granular and provides features such as faceting, filtering, and other options.

Previously, search is implemented using Simple-Jekyll-Search, a javascript-based search that does not require any extra Jekyll plugins. This provides a simple keyword and exact phrase search on volume pages and annotation content.

Citation Information

By default, this site is set up to embed publication information on the home page to make your annotated edition easily citable by tools like Zotero. To customize the citation, you can edit the publication_info section of your _config.yml. If you add a publisher or a rights statement, they will be included in your citation.

OpenGraph and Twitter metadata

The site includes OpenGraph and Twitter card metadata for most pages. The home page uses the site title and configured home page image; if a page has images associated (i.e., volume page images), an image will be included. An excerpt will be included if available, and you can set a custom excerpt by adding one to the Jekyll front matter for any page (other than the home page).