mkdocs.yml

# Copyright (c) 2016-2018 Martin Donath <martin.donath@squidfunk.com>
# Copyright (c) 2018 XQEMU Developers

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Project information
site_name: XQEMU
site_description: 'Experimental Xbox emulator'
site_author: 'XQEMU Developers'
site_url: https://xqemu.com

# Repository
repo_name: xqemu/xqemu
repo_url: https://github.com/xqemu/xqemu
edit_uri: https://github.com/xqemu/xqemu.com/blob/master/docs/

# Copyright
copyright: 'Copyright &copy; 2018-2019 XQEMU Developers'

# Configuration
theme:
  name: material
  palette:
    primary: green
    accent: light green

  # 404 page
  # static_templates:
  #   - 404.html

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  feature:
    tabs: true
  font:
    text: Roboto
    code: Roboto Mono
  logo:
    icon: "games"

# Extensions
markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - 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.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Welcome: index.md
  - Screenshots: screenshots.md
  - Getting Started: getting-started.md
  - Input Devices: input.md
  - Networking: networking.md
  - Tips: tips.md
  - FAQ: faq.md
  - Developers:
    - Welcome: developers/index.md
    - Building: developers/building.md