mkdocs.yml

site_name: Spotify Electron Documentation
site_author: Antonio Martinez Fernandez
repo_url: https://github.com/AntonioMrtz/SpotifyElectron
site_description: Documentation for Spotify Electron, an open-source cross-platform music streaming app
remote_branch: gh-pages

nav:
  - Home: index.md
  - Project Vision: VISION.md
  - How to contribute: CONTRIBUTING.md
  - Developer guides:
    - Git convention: developer/Git-Convention.md
    - Architecture: developer/Architecture.md
    - Global Set up: developer/SETUP.md
    - Authentication & Login: developer/Auth-Login.md
    - Backend:
        - Set up: developer/backend/SETUP.md
        - Environment: developer/backend/Environment.md
        - File Structure: developer/backend/File-Structure.md
        - Docker: developer/backend/Docker.md
        - Linting & Formatting: developer/backend/Linting-&-Formatting.md
        - Cloud: developer/backend/Cloud.md
        - Testing: developer/backend/Testing.md
        - FAQ: developer/backend/FAQ.md
    - Frontend:
        - Set up: developer/frontend/SETUP.md
        - File Structure: developer/frontend/File-Structure.md
        - Linting & Formatting: developer/frontend/Linting-&-Formatting.md
        - Testing: developer/frontend/Testing.md
        - Package app: developer/frontend/Package-app.md
        - FAQ: developer/frontend/FAQ.md
    - Utils:
      - Release procedure: developer/utils/Release-Procedure.md
      - OpenAPI schema generation & usage: developer/utils/OpenAPI.md
      - Mkdocs development & usage: developer/utils/Mkdocs.md
      - Generate Mock data: developer/utils/Generate-Mock-Data.md
      - Testing principles: developer/utils/Testing-Principles.md
  - User guides:
    - Installation guide: user/user-guides/Installation-Guide.md
  - Code of conduct: CODE_OF_CONDUCT.md
  - Contributors: CONTRIBUTORS.md

theme:
  logo: assets/logo.png
  name: material
  features:
    - navigation.indexes
  palette:
    - scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

plugins:
  - mkdocstrings
  - search
  - mkdocs-video

markdown_extensions:
  - mdx_truly_sane_lists
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences