_config.yml

# 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.

# 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: OpenRVDAS Documentation
email: info@openrvdas.org
description: >- # this means to ignore newlines until "baseurl:"
    The Open Research Vessel Data Acquisition System (OpenRVDAS) is a
    software framework used for building custom data acquisition systems
    (DAS).  OpenRVDAS target audiences are oceanographic research vessel
    operators and operators of other science-related platforms that have
    the need to record streaming data.  OpenRVDAS is capable of reading
    data records from serial ports and network-aware sensors, optionally
    modifying those data records and streaming either the result to one or
    more destinations, including logfiles, network ports, databases, etc.

    OpenRVDAS is designed to be modular and extensible, relying on simple
    composition of Readers, Transforms and Writers to achieve the needed
    datalogging functionality.
#twitter_username: username
github_username: oceandatatools
minimal_mistakes_skin: default
search: true

# Build settings
markdown: kramdown
theme: minimal-mistakes-jekyll
#remote_theme: mmistakes/minimal-mistakes

# Outputting
permalink: /:categories/:title/
paginate: 5 # amount of posts to show
paginate_path: /page:num/
timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

include:
  - _pages
  - _docs
  - assets/files

# 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/

# Plugins (previously gems:)
plugins:
  - jekyll-paginate
  - jekyll-sitemap
  - jekyll-gist
  - jekyll-feed
  - jemoji
  - jekyll-include-cache

author:
  #name   : "OpenRVDAS"
  #avatar : "/assets/images/shell.jpg"
  bio    : "OpenRVDAS (Open Research Vessel Data Acquisition System) is an open source
    software framework used for building custom data acquisition systems."
  #links:
    #- label: "Ocean Data Tools Home"
    #  icon: "fas fa-fw fa-link"
    #  url: "https:/oceandata.tools"
    #- label: "GitHub Repository"
    #  icon: "fab fa-fw fa-github"
    #  url: "https://github.com/OceanDataTools/openrvdas"

footer:
  links:
    - label: "info@openrvdas.org"
      icon: "fa-solid fa-envelope"
      url: "mailto:info@openrvdas.org"
    - label: "GitHub Repository"
      icon: "fab fa-fw fa-github"
      url: "https://github.com/OceanDataTools/openrvdas"
    - label: "MIT Open Source License"
      icon: "fas fa-file-alt"
      url: "https://opensource.org/license/mit"

# Add custom JS
after_footer_scripts:
  - /assets/js/custom.js

############################
defaults:
  # _posts
  #- scope:
  #    path: ""
  #    type: posts
  #  values:
  #    layout: single
  #    author_profile: true
  #    read_time: true
  #    comments: true
  #    share: true
  #    related: true

  # _docs
  - scope:
      path: ""
      type: docs
    values:
      sidebar:
        nav: "navdocs"

  - scope:
      path: ""
      type: pages
    values:
      layout: home
      author_profile: true
      sidebar:
        nav: "navdocs"

  # _pages
  #- scope:
  #    path: "_pages"
  #    type: pages
  #  values:
  #    layout: single
  #    author_profile: true

#toc:
#  min_level: 1
#  max_level: 6
#  no_toc_section_class: "no_toc_section"
#  list_class: "toc-list"
#  sublist_class: "toc-sublist"
#  item_class: "toc-list-item"

toc: true
toc_label: "Table of Contents"
toc_icon: "cog"  # Choose an icon from FontAwesome (optional)
toc_levels: "1..4"  # Define which heading levels to include in the TOC

############################
category_archive:
  type: liquid
  path: /categories/
tag_archive:
  type: liquid
  path: /tags/

collections:
  docs:
    output: true
    permalink: /:collection/:name