Merge pull request #668 from MITLibraries/timx-196-mitl-theme

Initial MITL theme
MITLibraries · Mar 3, 2023 · 689b5e8 · 689b5e8
2 parents 95bf67f + e50c504
commit 689b5e8
Show file tree

Hide file tree

Showing 16 changed files with 405 additions and 2 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,7 +1,7 @@
 title: TIMDEX API Documentation
 description: MIT Libraries TIMDEX API Documentation
 
-remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
+remote_theme: just-the-docs/just-the-docs@v0.4.1
 plugins:
   - "jekyll-remote-theme"
   - "jekyll-seo-tag"

diff --git a/docs/_includes/footer_custom.html b/docs/_includes/footer_custom.html
@@ -0,0 +1,40 @@
+<footer class="footer-info-institute" aria-label="MIT footer" role="contentinfo">
+  <p>
+    <strong>T</strong>IMDEX <strong>I</strong>s <strong>M</strong>aking <strong>D</strong>iscovery
+    <strong>EX</strong>cellent.
+  </p>
+
+  <a class="link-logo-mit" href="https://www.mit.edu">
+    <span class="sr">MIT</span>
+    <svg
+      x="0"
+      y="0"
+      width="54"
+      height="28"
+      viewBox="0 0 54 28"
+      enable-background="new 0 0 54 28"
+      xml:space="preserve"
+      class="logo-mit"
+    >
+      <rect x="28.9" y="8.9" width="5.8" height="19.1" class="color"></rect>
+      <rect width="5.8" height="28"></rect>
+      <rect x="9.6" width="5.8" height="18.8"></rect>
+      <rect x="19.3" width="5.8" height="28"></rect>
+      <rect x="38.5" y="8.9" width="5.8" height="19.1"></rect>
+      <rect x="38.8" width="15.2" height="5.6"></rect>
+      <rect x="28.9" width="5.8" height="5.6"></rect>
+    </svg>
+  </a>
+  <div class="about-mit">
+    <span class="item">Massachusetts Institute of Technology</span>
+  </div>
+  <div class="license">
+    Content created by the MIT Libraries,
+    <a href="https://creativecommons.org/licenses/by-nc/4.0/">CC BY-NC</a> unless otherwise noted.
+    <a href="https://libraries.mit.edu/research-support/notices/copyright-notify/">Notify us about copyright concerns</a
+    >.
+  </div>
+  <div>
+    <a href="https://libraries.mit.edu/accessibility">Accessibility</a>
+  </div>
+</footer>
diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html
@@ -0,0 +1,12 @@
+<meta name="color-scheme" content="dark light" />
+
+<link
+  rel="stylesheet"
+  href="{{ '/assets/css/just-the-docs-light.css' | relative_url }}"
+  media="(prefers-color-scheme: light)"
+/>
+<link
+  rel="stylesheet"
+  href="{{ '/assets/css/just-the-docs-dark.css' | relative_url }}"
+  media="(prefers-color-scheme: dark)"
+/>
diff --git a/docs/_includes/nav_footer_custom.html b/docs/_includes/nav_footer_custom.html
@@ -0,0 +1,4 @@
+<div class="nav-footer">
+  <p>Need help?</p>
+  <p>Contact us at timdex@mit.edu</p>
+</div>
diff --git a/docs/_includes/title.html b/docs/_includes/title.html
@@ -0,0 +1,8 @@
+<div class="site-logo">
+  <svg xmlns="http://www.w3.org/2000/svg" viewBox="5 -3 210 95" height="50px">
+    <title>MIT Libraries logo</title>
+    <path
+      d="M8.12,9H20l4.35,15.65c.17.57.36,1.31.58,2.22s.44,1.81.67,2.68.53,2.12.8,3.25h.1c.23-1.13.48-2.22.75-3.25.2-.87.42-1.76.65-2.67s.43-1.65.6-2.22L32.92,9h12V44.75h-8.1V22.66c0-.93,0-1.95.1-3.05h-.1c-.27,1-.5,2-.7,2.85s-.38,1.61-.53,2.22l-.42,1.58-5.1,18.49h-7.3L17.67,26.3c-.1-.33-.25-.87-.45-1.6s-.38-1.48-.55-2.25-.42-1.82-.67-2.85h-.1v3c0,.8,0,1.6.08,2.4a8.53,8.53,0,0,1,0,1.75v18H8V9Zm40,0H57V44.75H48.12Zm22.1,7.45H59.82V9H89.57v7.45H79.07v28.3H70.22ZM8.12,50H17V78.25H33.64v7.5H8.12Zm28.7,0H45v6.6H36.82Zm0,10.15H45v25.6H36.82Zm27,26.4a9.82,9.82,0,0,1-4.55-1,7.9,7.9,0,0,1-3.2-3H56v3.2H48.2V50h8.15V63h.15a9.45,9.45,0,0,1,2.9-2.55,8.62,8.62,0,0,1,4.37-1,9.86,9.86,0,0,1,4.53,1,10,10,0,0,1,3.45,2.85A13.51,13.51,0,0,1,74,67.6a17.89,17.89,0,0,1,.7,5.4,19.45,19.45,0,0,1-.78,5.72A12.53,12.53,0,0,1,71.72,83a9.48,9.48,0,0,1-3.45,2.67A10.63,10.63,0,0,1,63.82,86.55Zm-2.3-6.45a4.14,4.14,0,0,0,3.67-1.92,9.45,9.45,0,0,0,1.28-5.27,9.74,9.74,0,0,0-1.28-5.3,4.2,4.2,0,0,0-3.77-2,4.43,4.43,0,0,0-4,2.1A9.7,9.7,0,0,0,56.12,73a8.49,8.49,0,0,0,1.45,5.17,4.69,4.69,0,0,0,4,2Zm15.11-20h7.8v4h.15a9.56,9.56,0,0,1,3-3.35,7.29,7.29,0,0,1,4-1,4.57,4.57,0,0,1,1.6.2v7H93a7.34,7.34,0,0,0-6,1.27q-2.16,1.78-2.16,6v11.5H76.63Zm26,26.3a12.1,12.1,0,0,1-3.53-.5,7.55,7.55,0,0,1-2.77-1.5A7,7,0,0,1,94.48,82a8.09,8.09,0,0,1-.66-3.4,7.29,7.29,0,0,1,.78-3.52,6.74,6.74,0,0,1,2.12-2.35,10.79,10.79,0,0,1,3.1-1.43,27,27,0,0,1,3.77-.75,24.35,24.35,0,0,0,5-1A1.93,1.93,0,0,0,110,67.7a2.56,2.56,0,0,0-.83-2,3.91,3.91,0,0,0-2.67-.7,4.41,4.41,0,0,0-3,.85,3.66,3.66,0,0,0-1.2,2.45H94.8a8.52,8.52,0,0,1,.8-3.4,8.14,8.14,0,0,1,2.17-2.8,10.65,10.65,0,0,1,3.58-1.9,16.29,16.29,0,0,1,5-.7,19.72,19.72,0,0,1,4.9.52,9.7,9.7,0,0,1,3.4,1.58,7.31,7.31,0,0,1,2.45,3,10.5,10.5,0,0,1,.8,4.25v12.9a13.08,13.08,0,0,0,.17,2.42,1.8,1.8,0,0,0,.73,1.23v.35h-7.9a3.53,3.53,0,0,1-.5-1.12,14.56,14.56,0,0,1-.35-1.72h0a8.4,8.4,0,0,1-2.73,2.54,10,10,0,0,1-4.68,1Zm2.6-5.2a5.46,5.46,0,0,0,3.68-1.2,4.27,4.27,0,0,0,1.42-3.35v-3a11.5,11.5,0,0,1-1.87.73c-.72.22-1.5.43-2.34.62a10.36,10.36,0,0,0-3.4,1.27,2.48,2.48,0,0,0-1,2.17,2.43,2.43,0,0,0,1,2.2,4.53,4.53,0,0,0,2.5.55h0Zm15.87-21h7.77v4H129a9.56,9.56,0,0,1,3-3.35,7.29,7.29,0,0,1,4-1,4.57,4.57,0,0,1,1.6.2v7h-.2a7.34,7.34,0,0,0-6,1.27c-1.49,1.22-2.24,3.22-2.23,6V85.75H121V60.15ZM140,50.1h8.13v6.6H140Zm0,10.15h8.13v25.5H140ZM164,86.6a15,15,0,0,1-5.7-1,12.07,12.07,0,0,1-4.3-2.85,12.84,12.84,0,0,1-2.7-4.33,15.07,15.07,0,0,1-1-5.4,14.74,14.74,0,0,1,1-5.33,12.72,12.72,0,0,1,2.7-4.3,12.58,12.58,0,0,1,4.13-2.94,14.62,14.62,0,0,1,10.28-.17,12.29,12.29,0,0,1,3.83,2.35A12.7,12.7,0,0,1,175.65,68a20.83,20.83,0,0,1,1.08,7.13H158.32a7.53,7.53,0,0,0,1.8,4.1,5.14,5.14,0,0,0,4,1.5,4.84,4.84,0,0,0,2.65-.68,4.28,4.28,0,0,0,1.6-1.87h8a9.47,9.47,0,0,1-1.5,3.33,10.85,10.85,0,0,1-2.8,2.73A12.06,12.06,0,0,1,168.49,86a15.31,15.31,0,0,1-4.52.5Zm4.5-16.3a6,6,0,0,0-1.5-3.65,4.37,4.37,0,0,0-3.3-1.35,4.64,4.64,0,0,0-3.6,1.35,7,7,0,0,0-1.65,3.65Zm21.9,16.35q-5.66,0-9-2.42a8.34,8.34,0,0,1-3.52-6.78h7.7A4.15,4.15,0,0,0,187,80.3a5.06,5.06,0,0,0,3.25,1,5.61,5.61,0,0,0,2.92-.65,2.08,2.08,0,0,0,1.08-1.9,1.82,1.82,0,0,0-.55-1.37,4.08,4.08,0,0,0-1.45-.85,11.46,11.46,0,0,0-2.08-.5c-.78-.11-1.59-.25-2.42-.42q-1.65-.3-3.3-.72a10,10,0,0,1-3-1.28,6.41,6.41,0,0,1-2.12-2.27,7.47,7.47,0,0,1-.8-3.68,7.21,7.21,0,0,1,.87-3.55,7.61,7.61,0,0,1,2.35-2.66,11.15,11.15,0,0,1,3.53-1.55,17.18,17.18,0,0,1,4.28-.52c3.63,0,6.42.73,8.35,2.2a8,8,0,0,1,3.2,6h-7.5a3,3,0,0,0-1.33-2.37,5.48,5.48,0,0,0-2.78-.62,5,5,0,0,0-2.52.58A1.9,1.9,0,0,0,186,67a1.34,1.34,0,0,0,.5,1.1,4.27,4.27,0,0,0,1.35.67,13.55,13.55,0,0,0,2,.48l2.33.4c1.13.2,2.27.44,3.42.73a10.5,10.5,0,0,1,3.17,1.32,7,7,0,0,1,2.3,2.42,7.84,7.84,0,0,1,.9,4,7.35,7.35,0,0,1-3.32,6.38,11.84,11.84,0,0,1-3.7,1.6,18.75,18.75,0,0,1-4.66.5Z"
+    ></path>
+  </svg>
+</div>
diff --git a/docs/_sass/color_schemes/dark.scss b/docs/_sass/color_schemes/dark.scss
@@ -0,0 +1,29 @@
+@import 'global/variables';
+
+$body-background-color: $black;
+$body-text-color: $white;
+$body-heading-color: $gray-warm;
+
+$sidebar-color: $black;
+
+$border-color: $gray-d2;
+$nav-child-link-color: $gray-warm;
+$nav-link-color: $gray-warm;
+$search-result-preview-color: $grey-dk-000;
+$link-color: $blue-bright;
+$btn-primary-color: $blue;
+$base-button-color: $gray-d1;
+$search-background-color: $gray-d1;
+$table-background-color: $gray-d1;
+$feedback-color: darken($sidebar-color, 3%);
+
+$site-logo-color: $white;
+
+$code-background-color: $gray-d2;
+
+$footer-text-color: $gray-warm;
+
+.site-title,
+.site-title:hover {
+  background-image: url(../../assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038.svg) !important;
+}
diff --git a/docs/_sass/color_schemes/global/_variables.scss b/docs/_sass/color_schemes/global/_variables.scss
@@ -0,0 +1,120 @@
+
+// ----------------------------
+// #SETTINGS
+// ----------------------------
+$image-path: '/dest/i' !default;
+
+// ----------------------------
+// #GRID
+// ----------------------------
+
+// grid - breakpoints
+$bp-screen-sm:                  480px;
+$bp-screen-md:                  768px;
+$bp-screen-lg:                  1024px;
+$bp-screen-xl:                  1280px;
+
+
+// ----------------------------
+// #COLORS
+// ----------------------------
+
+// NOTE: if updating color variables, you should also update
+// the guide helper scss and the examples file;
+
+// colors - grayscale
+$black:                         #000;
+$black-t:                       #000; // true black
+$white:                         #fff;
+$white-warm:                    #ede8e2;
+$white-t:                       #fff; // true white
+$gray:                          #595959; // accessible on #f3f3f3
+$gray-d1:                       #333;
+$gray-d2:                       #222;
+$gray-l1:                       #767676; // accessible on #fff
+$gray-l2:                       #ccc;
+$gray-l3:                       #dedede;
+$gray-l4:                       #f3f3f3;
+$gray-warm:                     #c6b6a3;
+$transparent:                   rgba(0, 0, 0, 0); // transparent black
+$transparent-w:                 rgba(255,255,255,0); // transparent white
+$glare:                         rgba($white-t, .3);
+$shadow:                        rgba($black-t, .5);
+$smoke:                         rgba($gray, .3);
+$wisp:                          rgba($gray, .1);
+
+// pentagram colors - named
+$magenta:                       #FF00FF;
+$red:                           #FF0000;
+$orange:                        #FF7700;
+$yellow:                        #FFC800;
+$green:                         #00C800;
+$blue:                          #0000FF;
+$blue-bright:                   #00C8FF;
+
+// pentagram colors secondary
+$magenta-muted:                 #C702C7;
+$red-muted:                     #D50606;
+$orange-muted:                  #E46212;
+$yellow-muted:                  #FFC422;
+$green-muted:                   #008700;
+$blue-muted:                    #1A1A83;
+$blue-bright-muted:             #04A6CF;
+
+
+// colors - brand
+$brand-primary:                 $black;
+$brand-primary-accent:          $blue;
+$brand-primary2:                $blue-bright; // accessible on dark 
+$brand-secondary:               $magenta-muted;
+
+// colors - utilities
+$success:                       $green-muted;
+$warning:                       $yellow;
+$error:                         $red-muted;
+$informational:                 $gray;
+
+
+// ----------------------------
+// #TYPOGRAPHY
+// ----------------------------
+
+$base-font: 'Helvetica Neue', Helvetica, Arial, 'Open Sans', sans-serif;
+$alt-fonts: 'Georgia', Cambria, 'Times New Roman', Times, serif;
+
+// font-sizes and line-heights
+$fs-xxxsmall: .9rem;
+$fs-xxsmall: 1rem;
+$fs-xsmall: 1.2rem;
+$fs-smallish: 1.3rem;
+$fs-small: 1.4rem;
+$fs-base: 1.6rem;
+$fs-large: 2.0rem;
+$fs-xlarge: 2.6rem;
+$fs-xxlarge: 3.2rem;
+$fs-xxxlarge: 4.2rem;
+$fs-xxxxlarge: 4.8rem;
+
+$fw-bold: 600;
+$fw-normal: 400;
+$fw-light: 300;
+
+$lh-xtight: .92;
+$lh-tight: 1;
+$lh-base: 1.2;
+$lh-loose: 1.5;
+$lh-xloose: 1.7;
+
+
+// ----------------------------
+// #DEPTH
+// ----------------------------
+
+$z-depth-way-back:      -1000;
+$z-depth-back:           -100;
+$z-depth-lil-back:       -10;
+$z-depth-base:           1;
+$z-depth-lil-front:      10;
+$z-depth-front:          100;
+$z-depth-way-front:     1000;
+
diff --git a/docs/_sass/color_schemes/light.scss b/docs/_sass/color_schemes/light.scss
@@ -0,0 +1,27 @@
+@import 'global/variables';
+
+$body-background-color: $white;
+$sidebar-color: $gray-l4;
+$border-color: $grey-dk-200;
+$body-text-color: $black;
+$body-heading-color: $black;
+$nav-child-link-color: $blue;
+$nav-link-color: $blue;
+$search-result-preview-color: $grey-dk-000;
+$link-color: $blue;
+$btn-primary-color: $blue-200;
+$base-button-color: $grey-dk-250;
+$search-background-color: $grey-dk-250;
+$table-background-color: $grey-dk-250;
+$feedback-color: darken($sidebar-color, 3%);
+
+$site-logo-color: $black;
+
+$code-background-color: $white-warm;
+
+$footer-text-color: $black;
+
+.site-title,
+.site-title:hover {
+  background-image: url(../../assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038-light.svg) !important;
+}
diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss
@@ -0,0 +1,92 @@
+.site-header, .site-header:hover {
+  background-color: transparent;
+}
+
+.logo-mit {
+  fill: $body-text-color;
+}
+
+.site-logo {
+  fill: $site-logo-color;
+}
+
+.site-logo:hover {
+  fill: $link-color;
+}
+
+.site-title, .site-title:hover {
+  background-repeat: no-repeat;
+  background-position: 0 10%;
+  background-size: cover;
+}
+
+a:hover {
+  text-decoration: underline;
+}
+
+body {
+  font-family: Helvetica, Arial, sans-serif;
+  font-size: 18px;
+}
+
+.nav-list .nav-list-item {
+  font-family: Helvetica, Arial, sans-serif;
+  font-size: 20px !important;
+}
+
+.sr {
+  border: 0 none;
+  clip: rect(1px, 1px, 1px, 1px);
+  height: 1px;
+  margin: -1px;
+  overflow: hidden;
+  padding: 0;
+  position: absolute;
+  width: 1px;
+  word-wrap: normal;
+}
+
+@mixin sr-focusable {
+  &:focus {
+    position: static;
+    display: block;
+    height: auto;
+    width: auto;
+  }
+}
+
+body {
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+}
+
+.main {
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  margin-bottom: 5em;
+}
+
+footer {
+  color: $footer-text-color;
+  border-top: solid thin;
+  margin-top: auto;
+  padding-bottom: 1em;
+  position: fixed;
+  bottom: 0;
+  background-color: $body-background-color;
+  font-size: 12pt;
+}
+
+.side-bar {
+  color: $nav-link-color;
+}
+
+.side-bar a {
+  color: $nav-link-color;
+}
+
+.nav-footer {
+  padding-right: 1em;
+}
diff --git a/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038-light.svg b/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038-light.svg