_config.yml

# ==============================================================
# CONFIGURATION
# ==============================================================
# Jekyll configuration files are written in YAML format.
# Colons, tabs/spacing, and quotes are meaningful in YAML.
# It is recommended you look at the following guide to avoid
# syntax errors in this file:
# ~> https://learnxinyminutes.com/docs/yaml/
#
#
# Questions ?
# ~> https://minicomp.github.io/wiki/#/
# ~> https://gitter.im/minicomp/wax/
#
# ---------------------------------------------------------------
# MAIN SETTINGS
# ---------------------------------------------------------------
# Feel free to change these! For more info, refer to:
# ~> https://jekyllrb.com/docs/configuration/options/

title:            'Teach Viz by Example'
url:              'https://visualizingthefuture.github.io'
baseurl:          '/examples-repository'
copyright:        'Visualizing the Future, 2020'
logo:             '/img/logo.png'
github_user: visualizingthefuture
github_repo: examples-repository

# ---------------------------------------------------------------
# BUILD SETTINGS
# ---------------------------------------------------------------
# Best not to mess with these unless you know what you're doing!

permalink: 'pretty'
sass:
  style: compressed
exclude:
  - Gemfile*
  - Rakefile
  - vendor
  - spec
  - README.md
webrick:
  headers:
    'Access-Control-Allow-Origin': '*'
kramdown:
 auto_ids:       true
 footnote_nr:    1
 entity_output:  as_char
 footnote_backlink: "↩︎"
 toc_levels:     1..6
 smart_quotes:   lsquo,rsquo,ldquo,rdquo
 enable_coderay: false
#theme: jekyll-theme-cayman


# --------------------------------------------------------------
# COLLECTION SETTINGS
# --------------------------------------------------------------
# Wax leverages Jekyll collections for much of its
# functionality, therefor some of the keys below are from
# Jekyll while others are Wax-specific.
# For more info, refer to:
# ~> https://jekyllrb.com/docs/collections/

collections:
  exhibits:
    output: true
  datavis: # name of collection
    output: true # makes sure pages are output as html files
    layout: 'indiv_example' # the layout for the pages to use
    dictionary: 'data_dictionary'
    metadata:
      source: 'datavis.json' # path to the metadata file within `_data`
    images:
      source: 'raw_images/datavis' # path to the directory of images within `_data`
  datasets: # name of collection
    output: true # makes sure pages are output as html files
    layout: 'indiv_example' # the layout for the pages to use
    dictionary: 'data_dictionary'
    metadata:
      source: 'datasets.json' # path to the metadata file within `_data`
    images:
      source: 'raw_images/datasets' # path to the directory of images within `_data`


# --------------------------------------------------------------
# SEARCH INDEX SETTINGS
# --------------------------------------------------------------
# You can create multiple search indexes below (though only one is
# recommended!) by specifying
# an `index` file to write it to and some `collections` for it to index
# and running `$ bundle exec rake wax:search` .

search:
  main:
    index: '/search/index.json' # file the index will get written to
    collections:
      datavis:
        content: false # whether or not to index page content
        fields: # the metadata fields to index
          - pid
          - label
          - date_of_upload
          - creator
          - date_of_creation
          - source_url
          - description
          - vis_type
          - subject_area
          - original_context
          - audience_level
          - audience_composition
          - pedagogical_description
          - addl_data_props
          - ethical_quandries
          - data_processing
          - data_type
          - geospatial_std
          - language_tool
          - linked_code
          - linked_example
          - linked_instr_mtl
      datasets:
        content: false # whether or not to index page content
        fields: # the metadata fields to index
          - pid
          - label
          - date_of_upload
          - creator
          - date_of_creation
          - source_url
          - description
          - vis_type
          - subject_area
          - original_context
          - audience_level
          - audience_composition
          - pedagogical_description
          - addl_data_props
          - ethical_quandries
          - data_processing
          - data_type
          - geospatial_std
          - language_tool
          - linked_code
          - linked_example
          - linked_instr_mtl

# --------------------------------------------------------------
# SITE MENU SETTINGS
# --------------------------------------------------------------
# Each menu item needs a `label` (whats shown), and a `link`
# (where it goes). An item can optionally have a dropdown
# submenu via `sub`.

menu:
  - label: 'User Guide'
    link: '/howtoguide/'
  - label: 'Search'
    link: '/search/'
  - label: 'Browse'
    sub:
      - label: 'Browse Data Visualizations'
        link: '/datavis/'
      - label: 'Browse Data Sets'
        link: '/datasets/'

# --------------------------------------------------------------
#  - label: 'Featured'
#    sub:
#      - label: 'Featured Article A'
#        link: '/featured/a/'
#      - label: 'Featured Article B'
#        link: '/featured/b/'
# --------------------------------------------------------------

# --------------------------------------------------------------
# SITE FOOTER SETTINGS
 # - label: 'Browse'
 #   sub:
 #     - label: 'Browse Data Visualizations'
 #       link: '/collection/datavis/'
 #     - label: 'Browse Data Sets'
 #       link: ''/collection/dataset/'
# --------------------------------------------------------------
#

footer:
  links:
    - label: 'GitHub'
      link: 'https://github.com/visualizingthefuture/examples-repository'
    - label: 'Credits'
      link: '/credits'
  logos:
    - img: '/img/logo.png'

# FIN