# DVR-Scan Website
# Copyright (C) 2016 Brandon Castellano <http://www.bcastell.com>.
site_name: "DVR-Scan"
site_author: "Brandon Castellano"
docs_dir: "../docs"
site_dir: "build"
site_url: !!python/object/apply:os.getenv ["READTHEDOCS_CANONICAL_URL"]
edit_uri:  "blob/main/website/pages/"
repo_url: "https://github.com/Breakthrough/DVR-Scan"
repo_name: "DVR-Scan on Github"
copyright: 'Copyright &copy; 2016 Brandon Castellano.  All rights reserved.<br /><a href="https://github.com/Breakthrough/DVR-Scan/blob/main/LICENSE" alt="link to LICENSE on Github">Licensed under BSD 2-Clause license.'

theme:
  name: material
  custom_dir: overrides
  favicon: assets/dvr-scan.ico
  palette:
    #- scheme: slate
    #  primary: custom
    #  toggle:
    #    icon: material/brightness-4
    #    name: Switch to light mode
    - scheme: default
      primary: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode


  logo: assets/dvr-scan.svg
  icon:
    logo: material/magnify-scan
    repo: fontawesome/brands/github
    admonition:
      info: material/check
  font:
    text: "Rubik"
    code: "JetBrains Mono"

# TODO: Figure out how to have both tabs and regular nav at same time.
# TODO: Why doesn't the nav bar follow your progress on the Documentation page?
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.tabs.sticky
    - toc.follow
    - toc.integrate
    - content.code.copy

plugins:
 - search
 - minify:
    minify_html: true
    minify_js: true
    minify_css: true
    css_files:
        - style.css

markdown_extensions:
 - admonition
 - attr_list
 - fenced_code
 - pymdownx.details
 - pymdownx.tabbed:
    alternate_style: true
 - pymdownx.superfences
 - pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
 - toc:
    toc_depth: 6
    permalink: true



nav:
 - 'Download': 'download.md'
 - 'User Guide': 'guide.md'
 - 'Documentation': 'docs.md'
 - 'FAQ': 'faq.md'
 - 'Changelog': 'changelog.md'
 - 'Resources': 'resources.md'

extra_css:
  - style.css
