mkdocs.yml

site_name: Leapp - Docs
site_url: https://docs.leapp.cloud/
repo_url: https://github.com/Noovolari/leapp
site_description: 'Leapp is a tool for developers to manage, secure, and access the cloud. Manage AWS and Azure credentials centrally'
copyright: '© 2021 Noovolari, All rights reserved. | Powered by beSharp'

nav:
  - 'Get Started':
      - Overview: 'index.md'
      - Installation:
          - 'Requirements': 'installation/requirements.md'
          - 'Install Leapp': 'installation/install-leapp.md'
          - 'Update Leapp': 'installation/update-leapp.md'
      - 'Concepts':
          - Sessions: 'sessions.md'
          - Integrations: 'integrations.md'
  - 'CLI':
      - Index: 'cli/index.md'
      - Usage:
          - Help: 'cli/scopes/help.md'
          - Session: 'cli/scopes/session.md'
          - Integration: 'cli/scopes/integration.md'
          - Profile: 'cli/scopes/profile.md'
          - Region: 'cli/scopes/region.md'
          - 'Idp Url': 'cli/scopes/idp-url.md'
  - 'Configuration':
      - 'Add your first configuration': 'configuration.md'
      - 'Configuring a Session':
          - 'Configure AWS IAM User': 'configuring-session/configure-aws-iam-user.md'
          - 'Configure AWS IAM Role Federated': 'configuring-session/configure-aws-iam-role-federated.md'
          - 'Configure AWS IAM Role Chained': 'configuring-session/configure-aws-iam-role-chained.md'
          - 'Configure Azure Tenant': 'configuring-session/configure-azure-tenant.md'
      - 'Configuring an Integration':
          - 'Configure AWS Single Sign-On integration': 'configuring-integration/configure-aws-single-sign-on-integration.md'
      - 'Editing a session': 'edit-session.md'
  - Security:
      - 'Intro': 'security/intro.md'
      - 'Credentials Generation':
          - AWS:
            - 'Credential file': 'security/credentials-generation/aws.md'
            - 'Credential Process': 'security/credential-process.md'
          - Azure: 'security/credentials-generation/azure.md'
      - 'System Vault': 'security/system-vault.md'
      - 'Zero Knowledge':  'security/zero-knowledge.md'
  - 'Built-in features':
      - 'EC2 connect through AWS SSM': 'built-in-features/aws-ec2-connect.md'
      - 'AWS Multi-profile management': 'built-in-features/aws-named-profiles.md'
      - 'Opening AWS Web Console': 'built-in-features/opening-web-console.md'
  - 'General Options': 'built-in-features/general-options.md'
  - 'Roadmap': https://roadmap.leapp.cloud/tabs/4-in-progress
  - Contributing:
      - 'Get involved': 'contributing/get-involved.md'
  - Troubleshooting:
      - 'Application Data': 'troubleshooting/app-data.md'
      - 'FAQ': 'troubleshooting/faq.md'

theme:
  logo: images/leapp.png
  titles_only: true
  favicon: images/icon.ico
  name: material
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.top
    - content.code.annotate
  font:
    text: Montserrat
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-FB1NX90MYZ
  consent:
    cookies:
      analytics: Google Analytics
    title: Cookie consent
    description: >
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

markdown_extensions:
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.keys
  - meta
  - attr_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - mkdocs-video
  - img2fig