mkdocs.yml

site_name: Decompose
site_url: https://arkivanov.github.io/Decompose
site_author: Arkadii Ivanov
site_description: >-
  Kotlin Multiplatform lifecycle-aware business logic components (aka BLoCs) with routing functionality and pluggable UI (Compose, SwiftUI, JS React, etc.)

# Repository
repo_name: arkivanov/Decompose
repo_url: https://github.com/arkivanov/Decompose
edit_uri: ""

# Copyright
copyright: Copyright © 2020 - 2024 Arkadii Ivanov

# Page tree
nav:
  - Getting started:
    - Overview: index.md
    - Installation: getting-started/installation.md
    - Quick start: getting-started/quick-start.md
    - License: getting-started/license.md
    - Contributing: getting-started/contributing.md

  - Component:
    - Overview: component/overview.md
    - Child components: component/child-components.md
    - Lifecycle: component/lifecycle.md
    - State preservation (aka SavedStateHandle): component/state-preservation.md
    - Instance retaining (aka ViewModel): component/instance-retaining.md
    - Back button: component/back-button.md
    - Scoping jobs and subscriptions: component/scopes.md
    - Custom ComponentContext: component/custom-component-context.md

  - Navigation:
    - Overview: navigation/overview.md
    - Child Stack:
      - Overview: navigation/stack/overview.md
      - Navigation: navigation/stack/navigation.md
      - Deep linking: navigation/stack/deeplinking.md
      - Web browser history: navigation/stack/browser-history.md
    - Child Slot:
      - Overview: navigation/slot/overview.md
      - Navigation: navigation/slot/navigation.md
    - Child Pages:
        - Overview: navigation/pages/overview.md
        - Navigation: navigation/pages/navigation.md
    - Child Panels:
        - Overview: navigation/panels/overview.md
        - Navigation: navigation/panels/navigation.md
    - Generic Navigation:
        - Overview: navigation/children/overview.md
    - Web Navigation: navigation/web-navigation.md

  - Extensions:
    - Overview: extensions/overview.md
    - Extensions for Jetpack/JetBrains Compose: extensions/compose.md
    - Extensions for Android views: extensions/android.md

  - Samples: samples.md

  - Tips and Tricks:
    - Overview: tips-tricks/overview.md
    - Calling Composable functions with ViewModels: tips-tricks/composable-viewmodel.md
    - Hosting a component in navigation-compose: tips-tricks/navigation-compose-component.md

  - FAQ: faq.md
  - Community: community.md

  # Configuration
theme:
  name: 'material'

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - navigation.tabs
    - navigation.expand
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: media/logo/circle-2.png
  logo: media/logo/circle-2.png
  icon:
    logo: logo

# Plugins
plugins:
  - search
  - minify:
      minify_html: true

# Customization
extra:
  social:

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde