mkdocs.yml

# Project Information
site_name: Yacs
site_description: the free, open source course scheduler
site_author: Yacs Team
site_url: https://yacs.v2grad.ga
strict: false

# Repository
repo_name: 'V2grad/yacs-material'
repo_url: 'https://github.com/V2grad/yacs-material'
edit_uri: 'blob/master/docs/'

# Copyright
copyright: 'Copyright © 2014 - 2018 Yacs Team'

theme:
  name: null
  custom_dir: 'mkdocs-material/material'
  language: 'en'
  palette:
    primary: 'white'
    accent: 'red'
  include_search_page: false
  search_index_only: true
  favicon: 'favicon.ico'

  logo: '_static/media/logo.svg'
  feature:
    tabs: true
  font:
    text: 'Fira Sans'
    code: 'Fira Mono'


nav:
  - Overview:
    - Welcome to Yacs: index.md
    - Code Of Conduct: overview/code_of_conduct.md
    - Roadmap: overview/roadmap.md
  - Contributing:
    - Getting Started: contributors/getting_started.md
    - Setup Guide: contributors/setup_guide.md
    - Installing Docker: contributors/installing_docker.md
    - Running Yacs: contributors/running_yacs.md
  - Architecture:
    - Overview: architecture/overview.md
    - Service Map: architecture/service_map.md
    - Adapters: architecture/adapters.md
  - User Guides:
    - Students: user_guides/students.md
    - Faculty: user_guides/faculty.md
    - Administrators: user_guides/administrators.md
  - API:
    - Usage: api/usage.md


# Customization
extra:
  search:
    language: 'en'
  disqus: 'Yacs'
  social:
    - type: 'github'
      link: 'https://github.com/YACS-RCOS/'
    # - type: 'twitter'
    #   link: 'https://github.com/YACS-RCOS/'
  copyright: '<a href="https://creativecommons.org/licenses/by-sa/4.0/deed.zh">CC BY-SA 4.0</a>'

extra_javascript:
  - '_static/js/extra.js?v=1'

extra_css:
  - '_static/css/extra.css?v=1'

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: true
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.progressbar
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde