Ruby 2.7.2
withBundler
Node >= 16
withYarn >= 1.22
- Add the theme via GitHub to your Jekyll project's
Gemfile
:
gem 'iiifc-theme', github: 'mnyrop/iiifc-theme', branch: 'main'
Note: This will change to a IIIF org repo and use a tagged version instead of a branch name at the end of the development sprint.
- Install with Bundler:
bundle install
- And enable the theme in your
_config.yml
:
theme: iiifc-theme
To use a "sub-site" repo (with shared theme and menu configuration to IIIF/website
, e.g., IIIF/api
), you will need to override one or more URLs defined in the theme's _config.yml
.
The theme's _config.yml
defines absolute, public, production URLs like so:
# URLS
root_url: https://iiif.io
api_url: https://iiif.io/api
guides_url: https://guides.iiif.io
In your site repository, e.g., IIIF/api
, you should override the appropriate URL (in this case api_url
, to be local and relative):
api_url: /api
You should NOT need to define/override other URLs in the site's _config.yml
UNLESS you want to "pair" your site to another version of the other site, e.g.,
# URLS
root_url: https://preview.iiif.io/root/wireframe/
api_url: /api
If your site's content is NOT nested in a subdirectory (like IIIF/api
is in /api
) you should define the local url as blank, e.g.,
guides_url: ''
TO DO
TO DO
- Follow semantic versioning
- Create namespaced branches, e.g.,
feature/my-feature
- Add issue numbers to branches where possible
chore/my-chore-12
- Where possible, submit feature documentation with the feature itself
- Clone this repo and
cd
into it:
git clone https://github.com/mnyrop/iiifc-theme.git && cd iiifc-theme
- Install the Ruby dependencies
bundle install
- Install CSS and JS vendor dependencies
yarn install
- Make changes using your favorite text editor and preview them with
bundle exec jekyll serve