_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.
#
# If you need help with YAML syntax, here are some quick references for you: 
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# 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: Open Quantum Safe
email: contact@openquantumsafe.org
description: Open-source software for prototyping quantum-resistant cryptography
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://openquantumsafe.org" # the base hostname & protocol for your site, e.g. http://example.com
# twitter_username: jekyllrb
github_username:  open-quantum-safe

color_scheme: oqs

# Build settings
theme: just-the-docs
plugins:
  - jekyll-feed
  
nav_sort: case_insensitive

# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
#   - .sass-cache/
#   - .jekyll-cache/
#   - gemfiles/
#   - Gemfile
#   - Gemfile.lock
#   - node_modules/
#   - vendor/bundle/
#   - vendor/cache/
#   - vendor/gems/
#   - vendor/ruby/
exclude:
  - README.md
  - .git
  - .jekyll-cache

# just-the-docs theme configuration
search_enabled: true
search:
  heading_level: 4

heading_anchors: true

footer_content: "Copyright © Open Quantum Safe a Series of LF Projects, LLC.<br>For website terms of use, trademark policy, and other project policies, please see <a href='https://lfprojects.org'>https://lfprojects.org</a>.<br /> This site uses <a href='https://pmarsceill.github.io/just-the-docs/' target='_blank'>Just the Docs</a>, a documentation theme for Jekyll. Background image by <a href='https://commons.wikimedia.org/wiki/File:05_camera_painting_motion_blur_experimental_digital_photography_by_Rick_Doble.jpg'>Rick Doble</a>."

# Footer "Edit this page on GitHub" link text
gh_edit_link: false # show or hide edit this page link
gh_edit_link_text: "Edit this page on GitHub."
gh_edit_repository: "https://github.com/open-quanum-safe/www" # the github URL for your repo
gh_edit_branch: "master" # the branch that your docs is served from
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

callouts:
  highlight:
    color: yellow
  important:
    color: blue
  new:
    color: green
  note:
    color: purple
  warning:
    color: red