From 71fc71343401e3d8b24695aac53e88962f6bcbde Mon Sep 17 00:00:00 2001 From: beets Date: Mon, 20 Jul 2020 10:57:35 -0700 Subject: [PATCH] Built jekyll theme for docs (#43) Update styles to match datacommons.org * Add Boostrap-4.0.0 scss files * Fix sidebar ordering * Built new jekyll theme based on https://github.com/pmarsceill/just-the-docs * Add code syntax highlighting theme from https://raw.githubusercontent.com/jwarby/pygments-css/master/friendly.css * Update README --- .gitignore | 3 + Gemfile | 24 + Gemfile.lock | 251 +++++ README.md | 8 + _config.yml | 41 +- _includes/sidebar.html | 57 ++ _layouts/default.html | 77 ++ _sass/base.scss | 160 ++++ _sass/bootstrap-4.0.0/_alert.scss | 51 + _sass/bootstrap-4.0.0/_badge.scss | 47 + _sass/bootstrap-4.0.0/_breadcrumb.scss | 38 + _sass/bootstrap-4.0.0/_button-group.scss | 166 ++++ _sass/bootstrap-4.0.0/_buttons.scss | 143 +++ _sass/bootstrap-4.0.0/_card.scss | 270 ++++++ _sass/bootstrap-4.0.0/_carousel.scss | 191 ++++ _sass/bootstrap-4.0.0/_close.scss | 34 + _sass/bootstrap-4.0.0/_code.scss | 56 ++ _sass/bootstrap-4.0.0/_custom-forms.scss | 297 ++++++ _sass/bootstrap-4.0.0/_dropdown.scss | 131 +++ _sass/bootstrap-4.0.0/_forms.scss | 333 +++++++ _sass/bootstrap-4.0.0/_functions.scss | 86 ++ _sass/bootstrap-4.0.0/_grid.scss | 52 + _sass/bootstrap-4.0.0/_images.scss | 42 + _sass/bootstrap-4.0.0/_input-group.scss | 159 ++++ _sass/bootstrap-4.0.0/_jumbotron.scss | 16 + _sass/bootstrap-4.0.0/_list-group.scss | 115 +++ _sass/bootstrap-4.0.0/_media.scss | 8 + _sass/bootstrap-4.0.0/_mixins.scss | 42 + _sass/bootstrap-4.0.0/_modal.scss | 168 ++++ _sass/bootstrap-4.0.0/_nav.scss | 118 +++ _sass/bootstrap-4.0.0/_navbar.scss | 311 ++++++ _sass/bootstrap-4.0.0/_pagination.scss | 77 ++ _sass/bootstrap-4.0.0/_popover.scss | 183 ++++ _sass/bootstrap-4.0.0/_print.scss | 124 +++ _sass/bootstrap-4.0.0/_progress.scss | 33 + _sass/bootstrap-4.0.0/_reboot.scss | 482 ++++++++++ _sass/bootstrap-4.0.0/_root.scss | 19 + _sass/bootstrap-4.0.0/_tables.scss | 180 ++++ _sass/bootstrap-4.0.0/_tooltip.scss | 115 +++ _sass/bootstrap-4.0.0/_transitions.scss | 36 + _sass/bootstrap-4.0.0/_type.scss | 125 +++ _sass/bootstrap-4.0.0/_utilities.scss | 14 + _sass/bootstrap-4.0.0/_variables.scss | 894 ++++++++++++++++++ _sass/bootstrap-4.0.0/bootstrap-grid.scss | 32 + _sass/bootstrap-4.0.0/bootstrap-reboot.scss | 12 + _sass/bootstrap-4.0.0/bootstrap.scss | 42 + _sass/bootstrap-4.0.0/mixins/_alert.scss | 13 + .../mixins/_background-variant.scss | 21 + _sass/bootstrap-4.0.0/mixins/_badge.scss | 12 + .../mixins/_border-radius.scss | 35 + _sass/bootstrap-4.0.0/mixins/_box-shadow.scss | 5 + .../bootstrap-4.0.0/mixins/_breakpoints.scss | 123 +++ _sass/bootstrap-4.0.0/mixins/_buttons.scss | 109 +++ _sass/bootstrap-4.0.0/mixins/_caret.scss | 65 ++ _sass/bootstrap-4.0.0/mixins/_clearfix.scss | 7 + _sass/bootstrap-4.0.0/mixins/_float.scss | 11 + _sass/bootstrap-4.0.0/mixins/_forms.scss | 137 +++ _sass/bootstrap-4.0.0/mixins/_gradients.scss | 45 + .../mixins/_grid-framework.scss | 67 ++ _sass/bootstrap-4.0.0/mixins/_grid.scss | 52 + _sass/bootstrap-4.0.0/mixins/_hover.scss | 39 + _sass/bootstrap-4.0.0/mixins/_image.scss | 36 + _sass/bootstrap-4.0.0/mixins/_list-group.scss | 21 + _sass/bootstrap-4.0.0/mixins/_lists.scss | 7 + .../bootstrap-4.0.0/mixins/_nav-divider.scss | 10 + .../bootstrap-4.0.0/mixins/_navbar-align.scss | 10 + _sass/bootstrap-4.0.0/mixins/_pagination.scss | 22 + _sass/bootstrap-4.0.0/mixins/_reset-text.scss | 17 + _sass/bootstrap-4.0.0/mixins/_resize.scss | 6 + .../mixins/_screen-reader.scss | 35 + _sass/bootstrap-4.0.0/mixins/_size.scss | 6 + _sass/bootstrap-4.0.0/mixins/_table-row.scss | 30 + .../mixins/_text-emphasis.scss | 14 + _sass/bootstrap-4.0.0/mixins/_text-hide.scss | 9 + .../mixins/_text-truncate.scss | 8 + _sass/bootstrap-4.0.0/mixins/_transition.scss | 9 + _sass/bootstrap-4.0.0/mixins/_visibility.scss | 7 + _sass/bootstrap-4.0.0/utilities/_align.scss | 8 + .../utilities/_background.scss | 19 + _sass/bootstrap-4.0.0/utilities/_borders.scss | 59 ++ .../bootstrap-4.0.0/utilities/_clearfix.scss | 3 + _sass/bootstrap-4.0.0/utilities/_display.scss | 38 + _sass/bootstrap-4.0.0/utilities/_embed.scss | 52 + _sass/bootstrap-4.0.0/utilities/_flex.scss | 46 + _sass/bootstrap-4.0.0/utilities/_float.scss | 9 + .../bootstrap-4.0.0/utilities/_position.scss | 36 + .../utilities/_screenreaders.scss | 11 + _sass/bootstrap-4.0.0/utilities/_sizing.scss | 12 + _sass/bootstrap-4.0.0/utilities/_spacing.scss | 51 + _sass/bootstrap-4.0.0/utilities/_text.scss | 52 + .../utilities/_visibility.scss | 11 + _sass/friendly_code.scss | 64 ++ _sass/markup.scss | 52 + _sass/sidebar-nav.scss | 68 ++ api/python/index.md | 2 +- api/rest/index.md | 2 +- api/sheets/index.md | 4 +- assets/css/styles.scss | 62 ++ 98 files changed, 7505 insertions(+), 7 deletions(-) create mode 100644 Gemfile create mode 100644 Gemfile.lock create mode 100644 _includes/sidebar.html create mode 100644 _layouts/default.html create mode 100644 _sass/base.scss create mode 100644 _sass/bootstrap-4.0.0/_alert.scss create mode 100644 _sass/bootstrap-4.0.0/_badge.scss create mode 100644 _sass/bootstrap-4.0.0/_breadcrumb.scss create mode 100644 _sass/bootstrap-4.0.0/_button-group.scss create mode 100644 _sass/bootstrap-4.0.0/_buttons.scss create mode 100644 _sass/bootstrap-4.0.0/_card.scss create mode 100644 _sass/bootstrap-4.0.0/_carousel.scss create mode 100644 _sass/bootstrap-4.0.0/_close.scss create mode 100644 _sass/bootstrap-4.0.0/_code.scss create mode 100644 _sass/bootstrap-4.0.0/_custom-forms.scss create mode 100644 _sass/bootstrap-4.0.0/_dropdown.scss create mode 100644 _sass/bootstrap-4.0.0/_forms.scss create mode 100644 _sass/bootstrap-4.0.0/_functions.scss create mode 100644 _sass/bootstrap-4.0.0/_grid.scss create mode 100644 _sass/bootstrap-4.0.0/_images.scss create mode 100644 _sass/bootstrap-4.0.0/_input-group.scss create mode 100644 _sass/bootstrap-4.0.0/_jumbotron.scss create mode 100644 _sass/bootstrap-4.0.0/_list-group.scss create mode 100644 _sass/bootstrap-4.0.0/_media.scss create mode 100644 _sass/bootstrap-4.0.0/_mixins.scss create mode 100644 _sass/bootstrap-4.0.0/_modal.scss create mode 100644 _sass/bootstrap-4.0.0/_nav.scss create mode 100644 _sass/bootstrap-4.0.0/_navbar.scss create mode 100644 _sass/bootstrap-4.0.0/_pagination.scss create mode 100644 _sass/bootstrap-4.0.0/_popover.scss create mode 100644 _sass/bootstrap-4.0.0/_print.scss create mode 100644 _sass/bootstrap-4.0.0/_progress.scss create mode 100644 _sass/bootstrap-4.0.0/_reboot.scss create mode 100644 _sass/bootstrap-4.0.0/_root.scss create mode 100644 _sass/bootstrap-4.0.0/_tables.scss create mode 100644 _sass/bootstrap-4.0.0/_tooltip.scss create mode 100644 _sass/bootstrap-4.0.0/_transitions.scss create mode 100644 _sass/bootstrap-4.0.0/_type.scss create mode 100644 _sass/bootstrap-4.0.0/_utilities.scss create mode 100644 _sass/bootstrap-4.0.0/_variables.scss create mode 100644 _sass/bootstrap-4.0.0/bootstrap-grid.scss create mode 100644 _sass/bootstrap-4.0.0/bootstrap-reboot.scss create mode 100644 _sass/bootstrap-4.0.0/bootstrap.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_alert.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_background-variant.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_badge.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_border-radius.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_box-shadow.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_breakpoints.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_buttons.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_caret.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_clearfix.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_float.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_forms.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_gradients.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_grid-framework.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_grid.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_hover.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_image.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_list-group.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_lists.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_nav-divider.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_navbar-align.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_pagination.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_reset-text.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_resize.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_screen-reader.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_size.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_table-row.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_text-emphasis.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_text-hide.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_text-truncate.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_transition.scss create mode 100644 _sass/bootstrap-4.0.0/mixins/_visibility.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_align.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_background.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_borders.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_clearfix.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_display.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_embed.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_flex.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_float.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_position.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_screenreaders.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_sizing.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_spacing.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_text.scss create mode 100644 _sass/bootstrap-4.0.0/utilities/_visibility.scss create mode 100644 _sass/friendly_code.scss create mode 100644 _sass/markup.scss create mode 100644 _sass/sidebar-nav.scss create mode 100644 assets/css/styles.scss diff --git a/.gitignore b/.gitignore index c201beba6..d8455b1b8 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,6 @@ **/.DS_Store .AppleDouble .LSOverride + +.sass-cache/ +_site/ diff --git a/Gemfile b/Gemfile new file mode 100644 index 000000000..869c5839d --- /dev/null +++ b/Gemfile @@ -0,0 +1,24 @@ +source "https://rubygems.org" + +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins + +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.6" +end + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do + gem "tzinfo"#, "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform? diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..fe6f0a710 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,251 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (3.2.22.5) + i18n (~> 0.6, >= 0.6.4) + multi_json (~> 1.0) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.6) + dnsruby (1.61.3) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (1.0.1) + multipart-post (>= 1.2, < 3) + ffi (1.13.1) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (206) + github-pages-health-check (= 1.16.1) + jekyll (= 3.8.7) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.13.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.5.1) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.15.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.6.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.11.1) + kramdown (= 1.17.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.19.0) + terminal-table (~> 1.4) + github-pages-health-check (1.16.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 3.0) + typhoeus (~> 1.3) + html-pipeline (2.13.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.8.7) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (~> 1.14) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.13.0) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.5.1) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.15.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.1) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + rubyzip (>= 1.3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.11.1) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (1.17.0) + liquid (4.0.3) + listen (3.2.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + mini_portile2 (2.4.0) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + multi_json (1.15.0) + multipart-post (2.1.1) + nokogiri (1.10.10) + mini_portile2 (~> 2.4.0) + octokit (4.18.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (3.1.1) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) + ffi (~> 1.0) + rouge (3.19.0) + ruby-enum (0.8.0) + i18n + rubyzip (2.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (2.0.2) + concurrent-ruby (~> 1.0) + tzinfo-data (1.2020.1) + tzinfo (>= 1.0.0) + unicode-display_width (1.7.0) + wdm (0.1.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + jekyll-feed (~> 0.6) + minima (~> 2.0) + tzinfo + tzinfo-data + wdm (~> 0.1.0) + +BUNDLED WITH + 2.0.2 diff --git a/README.md b/README.md index 3738813af..caf8592c1 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,14 @@ to make public data accessible to everyone. To see the extent of data we have today, browse the graph using our [browser](https://browser.datacommons.org/). +## Developing locally + +The documentation site is built using Jekyll. To run this locally: +1. Install [Ruby](https://jekyllrb.com/docs/installation/) +1. `bundle update` +1. `bundle exec jekyll serve` + +If you make changes to yml files, re-run `bundle exec jekyll serve` ## License diff --git a/_config.yml b/_config.yml index 94a4e5fcc..70697c5ec 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,39 @@ -remote_theme: pmarsceill/just-the-docs +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. -# logo: "/assets/dc.png" -title: "datacommons.org" +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. +title: "Data Commons Docs" +description: Data Commons Documentation +url: "https://docs.dataacommons.org" +github_username: datacommonsorg -search_enabled: false \ No newline at end of file +# Build settings +markdown: kramdown +plugins: + - jekyll-feed + +sass: + style: compressed + +# Exclude from processing. +# The following items will not be processed, by default. Create a custom list +# to override the default setting. +exclude: + - Gemfile + - Gemfile.lock + - node_modules + - vendor/bundle/ + - vendor/cache/ + - vendor/gems/ + - vendor/ruby/ diff --git a/_includes/sidebar.html b/_includes/sidebar.html new file mode 100644 index 000000000..3405ca26b --- /dev/null +++ b/_includes/sidebar.html @@ -0,0 +1,57 @@ +{%- capture caret -%} + + + +{%- endcapture -%} + + \ No newline at end of file diff --git a/_layouts/default.html b/_layouts/default.html new file mode 100644 index 000000000..a78f8b3a8 --- /dev/null +++ b/_layouts/default.html @@ -0,0 +1,77 @@ + + + + + {{ page.title }} | Data Commons Docs + + + + + + + +
+
+ +
+ +
+
+
+ {% include sidebar.html %} +
+
+
+ {% unless page.url == "/" %} + {% if page.parent %} + + {% endif %} + {% endunless %} + {{ content }} +
+
+
+
+ + +
+ + + + diff --git a/_sass/base.scss b/_sass/base.scss new file mode 100644 index 000000000..dabef6f66 --- /dev/null +++ b/_sass/base.scss @@ -0,0 +1,160 @@ +/** + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + + // KEEP THIS FILE IN SYNC WITH: + // https://github.com/datacommonsorg/website/blob/master/static/css/base.scss + + :root { + --font-family: "Roboto", "Helvetica Neue", Arial, sans-serif !important; + --breakpoint-xl: 1040px; + --dc-red-strong: #660000; + --dc-red-lite: #9A0000; + --dc-red-fade: #f0e6e7; + --dc-gray: #3B3B3B; + --dc-gray-lite: #ccc; + --link-color: #660000; +} + +/** Bootstrap overrides **/ +$link-color: #660000; +$link-hover-color: $link-color; +$primary: $link-color; + +$font-family-sans-serif: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"; +$headings-font-family: 'Public Sans', $font-family-sans-serif; +$font-size-base: 1.0rem; + +$grid-breakpoints: ( +xs: 0, +sm: 576px, +md: 768px, +lg: 992px +); + +$container-max-widths: ( +sm: 540px, +md: 720px, +lg: 960px +); + +@import "bootstrap-4.0.0/bootstrap"; + +#main-nav .navbar-brand { +font-size: 1.1rem; +line-height: 24px; +} + +#main-nav .navbar-brand a { +color: #fff; +font-weight: 500; +} + +#main-nav .navbar-brand span, +#main-nav .navbar-brand span a { +font-weight: 200; +letter-spacing: 2px; +margin-left: .2rem; +} + +.main-content { +margin: 3rem auto 6rem; +} + +/** CSE **/ +#main-header #___gcse_0 { +width: 200px; +} + +#main-header .gsib_a { +padding: 3px 9px 3px 9px; +} + +#main-header .gsib_b { +display: none; +} + +#main-header .gsc-input-box { +border: none; +} + +#main-header form.gsc-search-box, +#main-header table.gsc-search-box { +margin-bottom: 0; +} + +#main-header table.gsc-search-box td.gsc-input { +padding-right: 0; +} + +#main-header .gsc-search-button.gsc-search-button-v2 { +background: rgba(255, 255, 255, .2) !important; +border-radius: 0 10px 10px 0; +border: none !important; +margin: 0 0 1px 0; +padding: 10px 10px 9px 8px; +} + +#main-header #gsc-iw-id1 { +border-radius: 10px 0 0 10px; +border: 1px solid $gray-300; +padding: 0; +} + +/** Shared page elements **/ +#main-header { +padding: .5rem 0; +background: var(--dc-red-strong); +box-shadow: 0px 2px 3px rgba(0,0,0,.1); +} + +#main-header .nav-item.dropdown { +margin-right: 1rem; +} + +#main-nav .dropdown-item, +#main-nav .nav-link { +/* Specify fonts in absolute px until we remove inclusion of MDL from tool pages */ +font-size: 14px; +font-weight: 400; +line-height: 24px; +} + +#main-footer { +background: #f0f0f0; +margin-top: 3rem; +padding-top: 3rem; +/* Trick to get the footer to extend to the bottom of short pages */ +box-shadow: 0 50vh 0 50vh #f0f0f0; +} + +#main-footer, #main-footer h6 { +font-size: .9rem; +} + +#main-footer #sub-footer { +border-top: 1px solid $gray-300; +padding-top: 1.5rem; +padding-bottom: 3rem; +} + +#main-footer section a { +display: block; +} + +#main-footer .col-12, +#main-footer .col-sm-6 { +margin-bottom: 2rem; +} \ No newline at end of file diff --git a/_sass/bootstrap-4.0.0/_alert.scss b/_sass/bootstrap-4.0.0/_alert.scss new file mode 100644 index 000000000..dd43e2376 --- /dev/null +++ b/_sass/bootstrap-4.0.0/_alert.scss @@ -0,0 +1,51 @@ +// +// Base styles +// + +.alert { + position: relative; + padding: $alert-padding-y $alert-padding-x; + margin-bottom: $alert-margin-bottom; + border: $alert-border-width solid transparent; + @include border-radius($alert-border-radius); +} + +// Headings for larger alerts +.alert-heading { + // Specified to prevent conflicts of changing $headings-color + color: inherit; +} + +// Provide class for links that match alerts +.alert-link { + font-weight: $alert-link-font-weight; +} + + +// Dismissible alerts +// +// Expand the right padding and account for the close button's positioning. + +.alert-dismissible { + padding-right: ($close-font-size + $alert-padding-x * 2); + + // Adjust close link position + .close { + position: absolute; + top: 0; + right: 0; + padding: $alert-padding-y $alert-padding-x; + color: inherit; + } +} + + +// Alternate styles +// +// Generate contextual modifier classes for colorizing the alert. + +@each $color, $value in $theme-colors { + .alert-#{$color} { + @include alert-variant(theme-color-level($color, $alert-bg-level), theme-color-level($color, $alert-border-level), theme-color-level($color, $alert-color-level)); + } +} diff --git a/_sass/bootstrap-4.0.0/_badge.scss b/_sass/bootstrap-4.0.0/_badge.scss new file mode 100644 index 000000000..b87a1b004 --- /dev/null +++ b/_sass/bootstrap-4.0.0/_badge.scss @@ -0,0 +1,47 @@ +// Base class +// +// Requires one of the contextual, color modifier classes for `color` and +// `background-color`. + +.badge { + display: inline-block; + padding: $badge-padding-y $badge-padding-x; + font-size: $badge-font-size; + font-weight: $badge-font-weight; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + @include border-radius($badge-border-radius); + + // Empty badges collapse automatically + &:empty { + display: none; + } +} + +// Quick fix for badges in buttons +.btn .badge { + position: relative; + top: -1px; +} + +// Pill badges +// +// Make them extra rounded with a modifier to replace v3's badges. + +.badge-pill { + padding-right: $badge-pill-padding-x; + padding-left: $badge-pill-padding-x; + @include border-radius($badge-pill-border-radius); +} + +// Colors +// +// Contextual variations (linked badges get darker on :hover). + +@each $color, $value in $theme-colors { + .badge-#{$color} { + @include badge-variant($value); + } +} diff --git a/_sass/bootstrap-4.0.0/_breadcrumb.scss b/_sass/bootstrap-4.0.0/_breadcrumb.scss new file mode 100644 index 000000000..25b9d85a1 --- /dev/null +++ b/_sass/bootstrap-4.0.0/_breadcrumb.scss @@ -0,0 +1,38 @@ +.breadcrumb { + display: flex; + flex-wrap: wrap; + padding: $breadcrumb-padding-y $breadcrumb-padding-x; + margin-bottom: $breadcrumb-margin-bottom; + list-style: none; + background-color: $breadcrumb-bg; + @include border-radius($border-radius); +} + +.breadcrumb-item { + // The separator between breadcrumbs (by default, a forward-slash: "/") + + .breadcrumb-item::before { + display: inline-block; // Suppress underlining of the separator in modern browsers + padding-right: $breadcrumb-item-padding; + padding-left: $breadcrumb-item-padding; + color: $breadcrumb-divider-color; + content: "#{$breadcrumb-divider}"; + } + + // IE9-11 hack to properly handle hyperlink underlines for breadcrumbs built + // without `