diff --git a/docs/_config.yml b/docs/_config.yml index 5909776..0fe9654 100644 --- 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 new file mode 100644 index 0000000..c7e1f6b --- /dev/null +++ b/docs/_includes/footer_custom.html @@ -0,0 +1,40 @@ + diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html new file mode 100644 index 0000000..3207070 --- /dev/null +++ b/docs/_includes/head_custom.html @@ -0,0 +1,12 @@ + + + + diff --git a/docs/_includes/nav_footer_custom.html b/docs/_includes/nav_footer_custom.html new file mode 100644 index 0000000..4a037c8 --- /dev/null +++ b/docs/_includes/nav_footer_custom.html @@ -0,0 +1,4 @@ +
+

Need help?

+

Contact us at timdex@mit.edu

+
diff --git a/docs/_includes/title.html b/docs/_includes/title.html new file mode 100644 index 0000000..6211ec2 --- /dev/null +++ b/docs/_includes/title.html @@ -0,0 +1,8 @@ + diff --git a/docs/_sass/color_schemes/dark.scss b/docs/_sass/color_schemes/dark.scss new file mode 100644 index 0000000..a970d27 --- /dev/null +++ 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 new file mode 100644 index 0000000..18fa150 --- /dev/null +++ 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 new file mode 100644 index 0000000..11fedc6 --- /dev/null +++ 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 new file mode 100644 index 0000000..978942f --- /dev/null +++ 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 new file mode 100644 index 0000000..4d678e8 --- /dev/null +++ b/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038-light.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038.svg b/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038.svg new file mode 100644 index 0000000..db4222b --- /dev/null +++ b/docs/assets/images/logo-cc616f47-6732-4cea-b061-887a9f971038.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/images/timdex-beaver.png b/docs/assets/images/timdex-beaver.png new file mode 100644 index 0000000..3393dd7 Binary files /dev/null and b/docs/assets/images/timdex-beaver.png differ diff --git a/docs/assets/images/vi-shape7-tp.png b/docs/assets/images/vi-shape7-tp.png new file mode 100644 index 0000000..6af234e Binary files /dev/null and b/docs/assets/images/vi-shape7-tp.png differ diff --git a/docs/assets/images/vi-shape7-tp.svg b/docs/assets/images/vi-shape7-tp.svg new file mode 100644 index 0000000..fc983b9 --- /dev/null +++ b/docs/assets/images/vi-shape7-tp.svg @@ -0,0 +1,5 @@ + + vi-shape7-tp + + diff --git a/docs/guides/using_filters.md b/docs/guides/using_filters.md index 96635e8..d5f6134 100644 --- a/docs/guides/using_filters.md +++ b/docs/guides/using_filters.md @@ -28,7 +28,7 @@ returned for each found record. } ``` -https://timdex.mit.edu/playground?query=%7B%0A%20%20search(searchterm%3A%20%22data%22%2C%20sourceFilter%3A%20%5B%22dspace%40mit%22%2C%20%22mit%20alma%22%5D)%20%7B%0A%20%20%20%20records%20%7B%0A%20%20%20%20%20%20source%0A%20%20%20%20%20%20sourceLink%0A%20%20%20%20%20%20title%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D +[Run this query in the GraphQL playground.](https://timdex.mit.edu/playground?query=%7B%0A%20%20search(searchterm%3A%20%22data%22%2C%20sourceFilter%3A%20%5B%22dspace%40mit%22%2C%20%22mit%20alma%22%5D)%20%7B%0A%20%20%20%20records%20%7B%0A%20%20%20%20%20%20source%0A%20%20%20%20%20%20sourceLink%0A%20%20%20%20%20%20title%0A%20%20%20%20%7D%0A%20%20%7D%0A%7D) ## See also diff --git a/docs/index_next.md b/docs/index_next.md index 4de8bf6..867b6ce 100644 --- a/docs/index_next.md +++ b/docs/index_next.md @@ -14,3 +14,5 @@ TIMDEX is a free discovery API into collections at MIT Libraries. This documentation site provides tutorials, guides, reference documentation, and technical overviews. If you have any questions, please reach out via timdex@mit.edu! + +![TIMDEX mascot: a variant of the MIT mascot with the words TIMDEX in a speech bubble!](/assets/images/timdex-beaver.png)