Skip to content

Commit 246ea60

Browse files
kenlhluikenlhlui
authored
Initial commit
0 parents  commit 246ea60

24 files changed

+1455
-0
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
push:
11+
branches: ["main"]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow one concurrent deployment
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: true
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v5
34+
- name: Setup Ruby
35+
uses: ruby/setup-ruby@v1
36+
with:
37+
ruby-version: "3.4"
38+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
39+
cache-version: 0 # Increment this number if you need to re-download cached gems
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v5
43+
- name: Build with Jekyll
44+
# Outputs to the './_site' directory by default
45+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
46+
env:
47+
JEKYLL_ENV: production
48+
- name: Upload artifact
49+
# Automatically uploads an artifact from the './_site' directory by default
50+
uses: actions/upload-pages-artifact@v4
51+
with:
52+
path: _site
53+
54+
# Deployment job
55+
deploy:
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
runs-on: ubuntu-latest
60+
needs: build
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deployment
64+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
3+
4+
# The first files are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/
16+
17+
# These next files are used by Just the Docs developers. They are not necessary for end users of the theme, only developers.
18+
19+
# We use Stylelint and Prettier, JavaScript tools, to lint and format our own code.
20+
# We use Node.js as our runtime, so we ignore node_modules
21+
node_modules
22+
23+
# .DS_Store is a macOS-only metadata file about directories. Convention is to not commit them.
24+
# See: https://en.wikipedia.org/wiki/.DS_Store
25+
.DS_Store
26+
27+
# These are legacy globs that typically target Ruby theme developers. We may change these at a later date.
28+
*.gem
29+
.bundle
30+
.ruby-version

‎.prettierignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
package-lock.json
2+
_site
3+
assets/css/just-the-docs-default.scss
4+
assets/css/just-the-docs-light.scss
5+
assets/css/just-the-docs-dark.scss
6+
assets/js/vendor/lunr.min.js
7+
assets/js/search-data.json
8+
assets/js/zzzz-search-data.json
9+
assets/js/just-the-docs.js
10+
*.md
11+
_includes/mermaid_config.js

‎.vscode/tasks.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=733558
3+
// for the documentation about the tasks.json format
4+
"version": "2.0.0",
5+
"tasks": [
6+
{
7+
"label": "Serve",
8+
"type": "shell",
9+
"command": "bundle exec jekyll serve --livereload",
10+
"group": {
11+
"kind": "test",
12+
"isDefault": true
13+
},
14+
"isBackground": true
15+
},
16+
{
17+
"label": "Build",
18+
"type": "shell",
19+
"command": "bundle exec jekyll build",
20+
"group": {
21+
"kind": "build",
22+
"isDefault": true
23+
}
24+
}
25+
]
26+
}

‎404.html‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: default
3+
title: 404
4+
permalink: /404
5+
nav_exclude: true
6+
search_exclude: true
7+
---
8+
9+
<h1>Page not found</h1>
10+
11+
<p>The page you requested could not be found. Try using the navigation {% if site.search_enabled != false %}or search {% endif %}to find what you're looking for or go to this <a href="{{ '/' | relative_url }}">site's home page</a>.</p>

‎Gemfile‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
source "https://rubygems.org"
2+
gemspec
3+
4+
gem "base64"
5+
gem "csv"
6+
7+
gem "jekyll-github-metadata", ">= 2.15"
8+
9+
gem "jekyll-include-cache", group: :jekyll_plugins
10+
gem "jekyll-sitemap", group: :jekyll_plugins
11+
12+
gem "html-proofer", "~> 5.0", :group => :development
13+
14+
gem "jekyll-remote-theme", "~> 0.4.3"

‎Gemfile.lock‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
PATH
2+
remote: .
3+
specs:
4+
mdlutoronto-jtd-theme (0.1.0)
5+
jekyll (>= 3.8.5)
6+
jekyll-include-cache
7+
jekyll-seo-tag (>= 2.0)
8+
rake (>= 12.3.1)
9+
10+
GEM
11+
remote: https://rubygems.org/
12+
specs:
13+
Ascii85 (2.0.1)
14+
addressable (2.8.7)
15+
public_suffix (>= 2.0.2, < 7.0)
16+
afm (1.0.0)
17+
async (2.34.0)
18+
console (~> 1.29)
19+
fiber-annotation
20+
io-event (~> 1.11)
21+
metrics (~> 0.12)
22+
traces (~> 0.18)
23+
base64 (0.3.0)
24+
bigdecimal (3.3.1)
25+
colorator (1.1.0)
26+
concurrent-ruby (1.3.5)
27+
console (1.34.1)
28+
fiber-annotation
29+
fiber-local (~> 1.1)
30+
json
31+
csv (3.3.5)
32+
em-websocket (0.5.3)
33+
eventmachine (>= 0.12.9)
34+
http_parser.rb (~> 0)
35+
ethon (0.15.0)
36+
ffi (>= 1.15.0)
37+
eventmachine (1.2.7)
38+
faraday (2.14.0)
39+
faraday-net_http (>= 2.0, < 3.5)
40+
json
41+
logger
42+
faraday-net_http (3.4.1)
43+
net-http (>= 0.5.0)
44+
ffi (1.17.2-x86_64-linux-gnu)
45+
fiber-annotation (0.2.0)
46+
fiber-local (1.1.0)
47+
fiber-storage
48+
fiber-storage (1.0.1)
49+
forwardable-extended (2.6.0)
50+
google-protobuf (4.32.1-x86_64-linux-gnu)
51+
bigdecimal
52+
rake (>= 13)
53+
hashery (2.1.2)
54+
html-proofer (5.0.10)
55+
addressable (~> 2.3)
56+
async (~> 2.1)
57+
nokogiri (~> 1.13)
58+
pdf-reader (~> 2.11)
59+
rainbow (~> 3.0)
60+
typhoeus (~> 1.3)
61+
yell (~> 2.0)
62+
zeitwerk (~> 2.5)
63+
http_parser.rb (0.8.0)
64+
i18n (1.14.7)
65+
concurrent-ruby (~> 1.0)
66+
io-event (1.11.2)
67+
jekyll (4.4.1)
68+
addressable (~> 2.4)
69+
base64 (~> 0.2)
70+
colorator (~> 1.0)
71+
csv (~> 3.0)
72+
em-websocket (~> 0.5)
73+
i18n (~> 1.0)
74+
jekyll-sass-converter (>= 2.0, < 4.0)
75+
jekyll-watch (~> 2.0)
76+
json (~> 2.6)
77+
kramdown (~> 2.3, >= 2.3.1)
78+
kramdown-parser-gfm (~> 1.0)
79+
liquid (~> 4.0)
80+
mercenary (~> 0.3, >= 0.3.6)
81+
pathutil (~> 0.9)
82+
rouge (>= 3.0, < 5.0)
83+
safe_yaml (~> 1.0)
84+
terminal-table (>= 1.8, < 4.0)
85+
webrick (~> 1.7)
86+
jekyll-github-metadata (2.16.1)
87+
jekyll (>= 3.4, < 5.0)
88+
octokit (>= 4, < 7, != 4.4.0)
89+
jekyll-include-cache (0.2.1)
90+
jekyll (>= 3.7, < 5.0)
91+
jekyll-remote-theme (0.4.3)
92+
addressable (~> 2.0)
93+
jekyll (>= 3.5, < 5.0)
94+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
95+
rubyzip (>= 1.3.0, < 3.0)
96+
jekyll-sass-converter (3.0.0)
97+
sass-embedded (~> 1.54)
98+
jekyll-seo-tag (2.8.0)
99+
jekyll (>= 3.8, < 5.0)
100+
jekyll-sitemap (1.4.0)
101+
jekyll (>= 3.7, < 5.0)
102+
jekyll-watch (2.2.1)
103+
listen (~> 3.0)
104+
json (2.15.1)
105+
kramdown (2.5.1)
106+
rexml (>= 3.3.9)
107+
kramdown-parser-gfm (1.1.0)
108+
kramdown (~> 2.0)
109+
liquid (4.0.4)
110+
listen (3.9.0)
111+
rb-fsevent (~> 0.10, >= 0.10.3)
112+
rb-inotify (~> 0.9, >= 0.9.10)
113+
logger (1.7.0)
114+
mercenary (0.4.0)
115+
metrics (0.15.0)
116+
net-http (0.6.0)
117+
uri
118+
nokogiri (1.18.10-x86_64-linux-gnu)
119+
racc (~> 1.4)
120+
octokit (6.1.1)
121+
faraday (>= 1, < 3)
122+
sawyer (~> 0.9)
123+
pathutil (0.16.2)
124+
forwardable-extended (~> 2.6)
125+
pdf-reader (2.15.0)
126+
Ascii85 (>= 1.0, < 3.0, != 2.0.0)
127+
afm (>= 0.2.1, < 2)
128+
hashery (~> 2.0)
129+
ruby-rc4
130+
ttfunk
131+
public_suffix (6.0.2)
132+
racc (1.8.1)
133+
rainbow (3.1.1)
134+
rake (13.3.0)
135+
rb-fsevent (0.11.2)
136+
rb-inotify (0.11.1)
137+
ffi (~> 1.0)
138+
rexml (3.4.4)
139+
rouge (4.6.1)
140+
ruby-rc4 (0.1.5)
141+
rubyzip (2.4.1)
142+
safe_yaml (1.0.5)
143+
sass-embedded (1.93.2-x86_64-linux-gnu)
144+
google-protobuf (~> 4.31)
145+
sawyer (0.9.2)
146+
addressable (>= 2.3.5)
147+
faraday (>= 0.17.3, < 3)
148+
terminal-table (3.0.2)
149+
unicode-display_width (>= 1.1.1, < 3)
150+
traces (0.18.2)
151+
ttfunk (1.8.0)
152+
bigdecimal (~> 3.1)
153+
typhoeus (1.5.0)
154+
ethon (>= 0.9.0, < 0.16.0)
155+
unicode-display_width (2.6.0)
156+
uri (1.0.4)
157+
webrick (1.9.1)
158+
yell (2.2.2)
159+
zeitwerk (2.7.3)
160+
161+
PLATFORMS
162+
x86_64-linux-gnu
163+
164+
DEPENDENCIES
165+
base64
166+
bundler (>= 2.3.5)
167+
csv
168+
html-proofer (~> 5.0)
169+
jekyll-github-metadata (>= 2.15)
170+
jekyll-include-cache
171+
jekyll-remote-theme (~> 0.4.3)
172+
jekyll-sitemap
173+
mdlutoronto-jtd-theme!
174+
175+
BUNDLED WITH
176+
2.5.9

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Map & Data Library, University of Toronto
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Map and Data Library JTD template
2+
3+
This repository is for creating a new just-the-docs based documentation with the Map and Data Library the default theme.
4+
5+
See the [Map & Data Library just-the-docs editing guide](https://mdlutoronto.github.io/jtd-edit-setup/docs/create-new-guide/) for more information on how to customize your documentation.

0 commit comments

Comments
 (0)