Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/ci_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ permissions:

jobs:
# Auto-generate date job to update _config.yml
auto-gen-date:
name: Update ci_last_modified_date in _config.yml
update-ci-last-modified-date:
name: Update ci_last_modified_date in _config
runs-on: ubuntu-latest
permissions:
contents: write
Expand All @@ -41,5 +41,5 @@ jobs:
- name: Commit and Push
uses: stefanzweifel/git-auto-commit-action@v7
with:
commit_message: "ci: Auto-update date to ${{ steps.set_date.outputs.date }}"
commit_message: "ci: Auto-update date to ${{ steps.set_date.outputs.date }} [skip ci]"
file_pattern: "_config.yml"
26 changes: 0 additions & 26 deletions .rulesets/README.md

This file was deleted.

32 changes: 0 additions & 32 deletions .rulesets/ci.json

This file was deleted.

73 changes: 1 addition & 72 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Map and Data Library JTD Theme
This is a customized version of the [Just the Docs](https://just-the-docs.com) theme for the [Map and Data Library](https://mdl.library.utoronto.ca) at the [University of Toronto Libraries](https://www.library.utoronto.ca).

# Using the template
This repository is a [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) that you can use to create your own documentation site using the [Just the Docs](https://just-the-docs.com) theme.

To create a new site using this template, click the green "Use this template" button above. This will create a new repository in your GitHub account with the contents of this repository.

# Using as a remote theme
You can use this repository as a remote theme, powered by the [jekyll-remote-theme plugin](https://github.com/benbalter/jekyll-remote-theme).

Expand All @@ -22,73 +17,7 @@ Also, you need to install the `jekyll-remote-theme` (version 0.4.3) gem by addin
gem "jekyll-remote-theme", "~> 0.4.3"
```

# Configuration options
## Site options
You can set the following options in your site's `_config.yml` file to customize site-wide information:

### Workshop series name (optional)
- workshop_series_name: Set this to the name of your workshop series to have it displayed in that page. For example:
```yaml
workshop_series_name: "NAME OF YOUR WORKSHOP SERIES"
```
This will display `This workshop is part of the {{NAME OF YOUR WORKSHOP SERIES}}` in the footer of each page.

### License (optional)
By default, the theme displays a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license icon in the footer of each page, linking to the [CC BY-NC-SA 4.0 license](https://creativecommons.org/licenses/by-nc-sa/4.0/).

You can set the following options to display license information in the footer of the site that applies to all pages:

- license_name: Set this to the name of the license. For example:
```yaml
license_name: "CC BY 4.0"
```
- license_url: Set this to the URL of the license. For example:
```yaml
license_url: "https://creativecommons.org/licenses/by-nc-sa/4.0/"
```
- license_image_url: Set this to the URL of the license image you want to display. For example:
```yaml
license_image_url: "https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg"
```
<a target="_blank" rel="noopener noreferrer" href="https://creativecommons.org/licenses/by-nc-sa/4.0/"><img src="https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg" alt="Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International icon" style="height:2em;"></a>

## Page options
You can set the following options in the front matter of your pages to customize the footer information:

### Dates
- created_date: Set this to the date the page was created. For example:
```yaml
created_date: 2025-10-06
```
- last_modified_date: Set this to the date the page was last modified. For example:
```yaml
last_modified_date: 2025-10-07
```
This will display `Content created: October 06, 2025 | Last updated: October 07, 2025` in the footer of the page.

If only one of these options is set, only that information will be displayed.

### Staff information
- staff_name: Set this to the name of the staff member who created the page. For example:
```yaml
staff_name: Ken Lui
```
- staff_link: Set this to the URL of the staff member's profile or website. For example:
```yaml
staff_link: https://library.utoronto.ca/staff/ken-lui
```
This will display `Tutorial created by Ken Lui` in the footer of the page, with `Ken Lui` being a link to the specified URL. If no link is provided, the name will be displayed as plain text.

### Student staff information (optional)
- student_name: Set this to the name of the student staff member who created the page. For example:
```yaml
student_name: Jane Doe
```
- student_link: Set this to the URL of the student staff member's profile or website. For example:
```yaml
student_link: https://library.utoronto.ca/staff/jane-doe
```
This will display `Tutorial created by Jane Doe` in the footer of the page, with `Jane Doe` being a link to the specified URL. If no link is provided, the name will be displayed as plain text.
Every time you push changes to your repository, GitHub Pages will automatically fetch the latest version of the theme from this repository.

# Development
## Testing the theme locally
Expand Down
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -205,4 +205,4 @@ compress_html:
sass:
quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
silence_deprecations: ["import"] # https://github.com/just-the-docs/just-the-docs/issues/1607
ci_last_modified_date: "2025-11-14" # automatically updated by GitHub Actions workflow ci_pr.yml. The format is 'YYYY-MM-DD'.
ci_last_modified_date: "2025-11-18" # automatically updated by GitHub Actions workflow ci_pr.yml. The format is 'YYYY-MM-DD'.
3 changes: 0 additions & 3 deletions _data/another_data.csv

This file was deleted.

3 changes: 0 additions & 3 deletions _data/csv_data.csv

This file was deleted.

10 changes: 0 additions & 10 deletions docs/children.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/children_2.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ created_date:
has_children: true
---

# This is the Home page!
This is the Home page!
See the [README](https://github.com/MDLutoronto/jtd-theme/blob/main/README.md) for documentation about this theme.
Loading