mkdocs.yml

site_name: chiaki-ng
repo_url: https://github.com/streetpea/chiaki-ng
site_url: https://streetpea.github.io/chiaki-ng/
edit_uri: edit/chiaki-ng/docs
nav:
  - Home: index.md
  - Setup:
    - Setup Overview: setup/index.md
    - Installation: setup/installation.md
    - Configuration: setup/configuration.md
    - Remote Connection: setup/remoteconnection.md
    - Automation: setup/automation.md
    - Game (Mode) Time: setup/steaming.md
    - Controller Options: setup/controlling.md
  - Updates:
    - Updates Overview: updates/index.md
    - Releases: updates/releases.md
    - Done: updates/done.md
    - Planned: updates/planned.md
  - DIY:
    - Building the Flatpak Yourself: diy/buildit.md
    - Locally Building Documentation: diy/builddocs.md
    - Developing chiaki-ng on Steam Deck: diy/steamdeckdev.md

theme:
  favicon: images/chiaking.svg
  logo: images/chiaking-logo-white.svg
  features:
    - header.autohide
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.footer
    - search.share
    - navigation.indexes
    - announce.dismiss
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.action.view
    
  name: material
  palette:
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      accent: lime
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: black
      accent: lime
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

copyright: >
  Copyright © 2022 Street Pea –
  <a href="#__consent">Change cookie settings</a>

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/streetpea/chiaki-ng
    - icon: fontawesome/brands/reddit
      link: https://www.reddit.com/u/Street_Pea_6693/?utm_source=share&utm_medium=ios_app&utm_name=iossmf
    - icon: fontawesome/brands/discord
      link: https://discord.gg/tAMbRuwXDH
  analytics:
    provider: google
    property: G-LCLEDWLWSR
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/heart
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/heart-broken
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help me improve this page by
            using my <a href="https://github.com/streetpea/chiaki-ng/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.

  consent:
    title: Cookie consent
    description: >- 
      I use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of my documentation and whether users
      find what they're searching for. With your consent, you're helping me to
      make my documentation better.

markdown_extensions:
  - abbr
  - admonition
  - codehilite
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde
  - attr_list
  - tables
  - toc:
      permalink: true
extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  - print-site:
      add_to_navigation: true