mkdocs.yml

# Project information
site_name: ShellHub
site_description: 'ShellHub enables teams to easily access any Linux device behind firewall and NAT'
site_url: 'https://shellhub-io.github.io'

# Repository
repo_name: 'shellhub-io/shellhub'
repo_url: 'https://github.com/shellhub-io/shellhub'

# Deployment
remote_branch: master

# Copyright
copyright: 'Copyright © 2020 O.S. Systems'

# Configuration
edit_uri: '/shellhub-io/shellhub-io.github.io/edit/src/docs'

# Theme
theme:
  name: 'material'
  custom_dir: 'theme'
  palette:
    scheme: slate
  font:
    text: Prompt, sans-serif
  features:
    - navigation.tabs
    - navigation.sections
  logo: img/logo-inverted.png

# Customization
extra:
  manifest: 'manifest.webmanifest'
  social:
    - type: 'github'
      link: 'https://github.com/OSSystems'
    - type: 'twitter'
      link: 'https://twitter.com/OSSystemsNews?s=20'
    - type: 'linkedin'
      link: 'https://www.linkedin.com/company/ossystems'

extra_css:
  - 'stylesheets/extra.css'

# 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_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - attr_list

# Plugins
plugins:
  - search
  - redirects:
      redirect_maps:
        'getting-started.md': 'https://shellhub-io.github.io/getting-started/installing/'
        'guides/connecting-device.md': 'https://shellhub-io.github.io/getting-started/connecting-device/'
        'guides/registering-device.md': 'https://shellhub-io.github.io/getting-started/registering-device/'
        'guides/adding-account.md': 'https://shellhub-io.github.io/getting-started/creating-account/'
  - markdownextradata: {}

# Navigation
nav:
  - Home: index.md
  - Introduction: introduction.md
  - Getting Started:
    - Installing: getting-started/installing.md
    - Creating account: getting-started/creating-account.md
    - Creating namespace: getting-started/creating-namespace.md
    - Registering a device: getting-started/registering-device.md
    - Connecting to a device: getting-started/connecting-device.md
  - Admin Manual:
      - Introduction: admin-manual/index.md
      - Installing: admin-manual/installing.md
      - Configuring: admin-manual/configuring.md
      - Running: admin-manual/running.md
      - Managing: admin-manual/managing.md
      - Updating: admin-manual/updating.md
      - Upgrade to Enterprise: admin-manual/upgrade-enterprise.md
      - Production Deployment: admin-manual/production-deployment.md
      - Admin Console: admin-manual/admin-console.md
  - User Manual:
      - Introduction: user-manual/index.md
      - Namespaces:
        - Overview: user-manual/namespaces/overview.md
        - Switching namespace: user-manual/namespaces/switching.md
      - Devices:
        - Listing devices: user-manual/devices/listing.md
        - Adding a device: user-manual/devices/adding.md
        - Connecting to a device: user-manual/devices/connecting.md
      - Sessions:
        - Auditing sessions: user-manual/sessions/introduction.md
        - Replaying a recorded session: user-manual/sessions/replaying.md
      - Security:
        - Using public keys for authentication: user-manual/security/publickey-authentication.md
        - Managing firewall rules: user-manual/security/managing-firewall-rules.md
      - Advanced:
        - Installing agent: user-manual/agent/installing.md
        - Configuring: user-manual/agent/configuring.md
  - ShellHub Cloud:
    - Introduction: cloud/index.md
    - Security: cloud/security.md
  - Support:
      Troubleshooting: support/troubleshooting.md
      Frequently Encountered Issues: support/faq.md
# Extra data
extra:
  shellhub:
    latest_version: v0.9.4
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_ID