_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 }}.

locale: en-US
title: pyOCD
site_title: pyOCD
copyright: The PyOCD Authors
lang: en-US
subtitle: "Python debug tools for Arm embedded devices"
description: >-
  pyOCD is an open source Python package for programming and debugging Arm CoreSight based microcontrollers
  using multiple supported types of USB debug probes.
search: false

repo_url: https://github.com/pyocd/pyOCD
github_edit_me_url: https://github.com/pyocd/pyocd-website-source/

markdown: kramdown
kramdown:
  input: GFM
  auto_ids: true
  hard_wrap: false
  syntax_highlighter: rouge

highlighter: rouge

sass:
#   style: compressed
  sass_dir: /assets/styles

# Outputting
permalink: /posts/:year/:month-:day-:title:output_ext
# paginate: 10 # amount of posts to show
# paginate_path: /page:num/
timezone: # https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

include:
  - _pages
exclude:
  - pyocd
  - pyocd/docs
  - _docs/Doxyfile
  - _docs/doxygen.*
  - README.md
  - build.sh

plugins:
  - jekyll-toc
#   - jekyll-paginate
#   - jekyll-sitemap
#   - jekyll-gist
#   - jekyll-feed
#   - jemoji
#   - jekyll-include-cache

footer:
  links:
    - label: "GitHub"
      icon: "fab fa-fw fa-github"
      url: "https://github.com/pyocd/pyOCD"

collections:
  docs:
    output: true
    permalink: /:collection/:path:output_ext

pages:
  - title: Documentation
    order: 1
    url: docs

defaults:
  - scope:
      path: ""
      type: "pages"
    values:
      layout: "default"
      show_toc: true
      site_title: pyOCD
  # _posts
  - scope:
      path: ""
      type: posts
    values:
      layout: post
      site_title: pyOCD
      comments: false
      share: false
      related: false
  # docs
  - scope:
      path: ""
      type: docs
    values:
      layout: docs
      site_title: pyOCD
      comments: false
      share: false
      related: false
      toc: true
      sidebar:
        nav: "docs"