cmu-lib / dhlg

dhlg

The Digital Humanities Literacy Guidebook is an outcome of the A.W. Mellon Digital Humanities grant project with Carnegie Mellon University. This repository contains the source code for a Jekyll-based static site.

Build and deployment

Building this site requires ruby >= 2.5.3

Ensure you have the bundler gem installed, then install the other dependencies for this site:

gem install bundler
bundle install

To preview the site locally:

bundle exec jekyll serve --watch --config _config.yml,_config_local.yml

To check for broken links:

bundle exec jekyll build  --config _config.yml,_config_local.yml
bundle exec htmlproofer ./_site --assume-extension --empty-alt-ignore --timeframe '30d' --allow-hash-href

Adding a new page

The following are required fields for all new *.md files, including project videos, topics, and content pages.

1. identifier - a unique lowercase HTML-compatible string (cannot begin with a number, and must contain only a-z characters, with no spaces) used to identify the project video page
2. meta_title- - the page title which will be displayed in the HTML
3. title - the page title displayed within the page body itself (can be the same as meta_title, but please supply both)
4. permalink - lower case url path relative to the baseurl / domain of the entire site, with a trailing slash / . This is used to generate the breadcrumbs in conjunction with the title field
5. creationdate: YYYY-MM-DD
6. date_updated: YYYY-MM-DD [this should be the last date the file was updated, only one value should be supplied]

for any page it is possible to add multiple authors using the following format:

authors:
- name: [enclose in double quotation marks "" if single quotations in the text ']
  bio: [enclose in double quotation marks "" and only use single quotations in the text ']
  affiliation: [enclose in double quotation marks "" if single quotations in the text ']
  uri:

1. adding new project video required fields include:

• breadcrumb: true
• layout: project
• disciplines: list of matching discipline identifiers
• topics: list of matching topic identifiers
• source: community [CMU contributors use core]
• youtubeid: [Youtube unique ID]
• teaser: [short description of the video, which will be truncated at 80 characters when displayed on the project videos landing page]

2. adding new dh topic

• topics: list of matching topic identifiers
• breadcrumb: false
• layout: page

3. adding new content page

• breadcrumb: true
• layout: page

For new content pages, please update _data/navigation.yml and place the page in the menu under existing main items. entries require the menu item text and the associated permalink, e.g.:

title: "Instructional Blogs / Misc"
url: "/global-resources/educational-resources/instructional-blogs"

For new disciplines, please update _data/disciplines.yml with the discipline name and a unique lower case identifier (as per above). This data file acts as a control for disciplines across the site: in order for projects to match by discipline, the discipline must appear in this data file even if the discipline is declared in the yaml header of the project. Entries are formatted as follows:

- identifier: "modernlanguages"
  name: "Modern Languages"

New topics are controlled by adding a new topic, with a unique identifier, and title.

A style guide is available.

Credits

This site was developed by Scott Weingart, Susan Grunewald, Matthew Lincoln, and Agile Humanities team members Matt Milner and Bill Kennedy.

Support for this project comes from the A.W. Mellon Foundation, Carnegie Mellon University Libraries, and Dietrich College for Humanities and Social Sciences.

The theme is based on the openly-licensed Jekyll theme Feeling Responsive

Contact

Scott B. Weingart