mkdocs.yml

site_name: Arcan Documentation
site_author: TXT Arcan s.r.l., Italy
site_description:
copyright: "© 2021-2024 TXT Arcan | TXT Arcan s.r.l., Italy. All rights reserved"
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/linkedin
      name: LinkedIn
      link: https://www.linkedin.com/company/arcan-tech
    - icon: fontawesome/brands/twitter
      name: Twitter
      link: https://twitter.com/arcan_tech
    - icon: fontawesome/brands/instagram
      name: Instagram
      link: https://instagram.com/arcan_tech
    - icon: fontawesome/brands/github
      name: GitHub
      link: https://github.com/Arcan-Tech
    - icon: fontawesome/solid/envelope
      name: Email
      link: mailto:info@arcan.tech
theme:
  name: material
  language: en
  logo: assets/images/logo.png
  favicon: assets/images/favicon.ico
  features:
    - navigation.top
  plugins:
    - social
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: pink
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: white
      accent: pink
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: material/alert-circle
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16  
markdown_extensions:
  - md_in_html
  - pymdownx.superfences
  - pymdownx.details
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - admonition
  
nav:
    - Welcome: 'index.md'
    - Getting started: 'get_started.md'
    - 'User guide':
        - 'Install Arcan': 'installation.md'
        - 'CI integration': 'ci_integration.md'
        - 'Analyse a new project': 'analyse_project.md'
        - 'Inspect a project': 'inspect_project.md'
    - 'Knowledge base':
        - 'Glossary': 'glossary.md'
        - 'Architectural smells': 'architectural_smells.md'
        - 'Metrics': 'metrics.md'
        - 'Results interpretation': 'interpretation.md'
        - 'Refactoring best pratices': 'refactoring.md'
    - 'Supported languages': 'compatibility.md'
    - 'Common issues': 'common-issues.md'
    - 'Support': 'support.md'