mkdocs.yml

site_name: Navixy Developer Documentation
site_url: https://developers.navixy.com
site_author: Navixy Team
site_description: >-
  API and technical documentation for developers and partners.
  Feel free to use our comprehensive REST API to integrate Navixy with CRMs,
  ERPs or any other 3rd party tools. You can also use it to build your custom web applications.

copyright: Copyright © 2020 Navixy

use_directory_urls: true
strict: true
docs_dir: docs

repo_name: SquareGPS/navixy-api
repo_url: https://github.com/SquareGPS/navixy-api
#edit_uri: ""

# now using awesome-pages plugin
#nav:
#  - General:
#      - Overview: general/index.md
#      - Getting Started: general/getting-started.md
#  - Backend API:
#      - Backend API: backend-api/index.md
#      - Resources: backend-api/resources/index.md
#  - Panel API:
#      - Panel API: panel-api/index.md
#  - Self-hosted:
#      - Self-hosted: self-hosted/index.md
#  - Localizations:
#      - Localizations: localizations/index.md

theme:
  name: material
  custom_dir: theme
  favicon: assets/images/favicon.ico
  icon:
    repo: fontawesome/brands/github
  palette:
    scheme: default
    primary: black
    accent: blue
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - tabs
  language: en

plugins:
  - search:
      separator: '[\s\_\.]+'
  - macros
  - minify:
      minify_html: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true
  - awesome-pages:
      filename: .pages.yml
      collapse_single_pages: false
      strict: true
  - pdf-export:
      combined: true
      combined_output_path: full-navixy-api-documentation.pdf
      theme_handler_path: theme/pdf-theme-handler.py
      media_type: print
      enabled_if_env: ENABLE_PDF_EXPORT

extra:
  #manifest: manifest.webmanifest todo
  repo_icon: github
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/SquareGPS
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/Navixy
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/company/navixy/
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/NavixyGPS
    - icon: fontawesome/brands/instagram
      link: https://instagram.com/squaregps
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/channel/UCL0u39pv4NlECAmFOZCZ-nw
    - icon: fontawesome/regular/address-card
      link: https://navixy.com/contact/
      name: Contacts

extra_css:
  - assets/stylesheets/extra.css

markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.attr_list
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.striphtml:
      strip_comments: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
#      repo_url_shorthand: true
#      user: SquareGPS
#      repo: todo
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

#google_analytics:
#  - UA-XXXXXXXX-X todo
#  - auto