AndroidJetpack/Jetpack-Compose-Playground/mkdocs.yml

site_name: Jetpack Compose Playground
repo_name: Jetpack Compose Playground

repo_url: https://github.com/Foso/Jetpack-Compose-Playground
site_url: https://github.com/Foso/Jetpack-Compose-Playground
docs_dir: 'docs'
edit_uri: 'tree/master/docs/'

# Copyright
copyright: Copyright © MIT License 2019 - 2023 Jens Klingenberg

theme:
  name: 'material'
  language: en
  custom_dir: 'docs/theme'
  font:
    text: Ubuntu
    code: Jetbrains Mono
  features:
    - navigation.instant
    - navigation.top
    - search.suggest
    - search.share
    - content.code.copy
  palette:
    - scheme: default
      primary: deep-blue
      accent: deep-purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    logo: fontawesome/solid/code
    repo: fontawesome/brands/github
extra:
  manifest: manifest.webmanifest
  site:
    samplefolder: 'https://github.com/Foso/Jetpack-Compose-Playground/blob/master/app/src/main/java/de/jensklingenberg/jetpackcomposeplayground/mysamples/github'
    composedoc: 'https://developer.android.com/reference/kotlin/androidx/compose'
    images: '../../images'
  compose:
    release: "1.5.0"
  social:
    - icon: fontawesome/brands/github-alt
      link: 'https://github.com/foso'
    - icon: fontawesome/brands/twitter
      link: 'https://twitter.com/jklingenberg_'
    - icon: fontawesome/solid/arrow-up-right-from-square
      link: 'https://jensklingenberg.de/'
nav:
  - 'Jetpack Compose':
      - 'Overview': index.md
      - 'Components':
          - 'Cards':
              - 'Card': material/card.md
          - 'Dialogs':
              - 'AlertDialog': material/alertdialog.md
          - 'Menus':
              - 'DropdownMenu': material/dropdownmenu.md
          - 'Progress indicators':
              - 'LinearProgressIndicator': material/linearprogressindicator.md
              - 'CircularProgressIndicator': material/circularprogressindicator.md
          - 'Selection controls':
              - 'Checkbox': material/checkbox.md
              - 'RadioButton': material/radiobutton.md
              - 'Switch': material/switch.md
          - 'Sliders':
              - 'Slider': material/slider.md
          - 'Snackbars':
              - 'Snackbar': material/snackbar.md
          - 'Text fields':
              - 'TextField': material/textfield.md
      - 'General':
          - 'Codelabs': general/codelabs.md
          - 'Compose Confusion': general/composeconfusion.md
          - 'Compiler Plugin': general/compiler_plugin.md
          - 'Compose for:':
            - 'Compose for Android Developers': compose_for/android_devs.md
            - 'Compose for SwiftUI Developers': compose_for/swiftui_devs.md
          - 'Compose Lifecycle': general/compose_lifecycle.md
          - 'CompositionLocal' : general/compositionlocal.md
          - 'CompositionLocalProvider': general/compositionlocalprovider.md
          - 'Hello World Compose': general/helloworld.md
          - 'Modifier': general/modifier.md
          - 'Navigation': general/navigation.md
          - 'Preview':
            - 'Preview': general/preview/preview.md
            - 'PreviewParameter': general/preview/previewparameter.md
          - 'Roadmap': general/roadmap.md
          - 'Project Setup': general/getting_started.md
          - 'State': general/state.md
          - 'UI Testing': general/testing.md
      - 'Cookbook':
           - 'Overview': cookbook/overview.md
           - 'Handle changes to a text field': cookbook/textfield_changes.md
           - 'How to use Compose in a ViewGroup': cookbook/how_to_use_compose_in_viewgroup.md
           - 'How to load an Image': cookbook/loadimage.md
           - 'How to use an Android View in Compose': cookbook/how_to_use_an_android_view_in_compose.md
           - 'How to get Android Context': cookbook/get_android_context.md
           - 'How to detect dark mode': cookbook/detect_darkmode.md
           - 'How to create a custom shape': cookbook/how_to_create_custom_shape.md
           - 'How to make a Composable invisible?': cookbook/how_to_make_composable_invisible.md
      - 'Compose UI':
          - 'Activity':
              - 'BackHandler': activity/backhandler.md
          - 'Animation':
              - 'Crossfade': animation/crossfade.md
          - 'Foundation':
              - 'Layout':
                 - 'Box': layout/box.md
                 - 'BoxWithConstraints': foundation/layout/boxwithconstraints.md
                 - 'Column': layout/column.md
                 - 'ConstraintLayout': layout/constraintlayout.md
                 - 'Row': layout/row.md
                 - 'Spacer': foundation/layout/spacer.md
              - 'Canvas': foundation/canvas.md
              - 'Image': foundation/image.md
              - 'Lazy':
                 - 'LazyColumn': foundation/lazycolumn.md
                 - 'LazyRow': foundation/lazyrow.md
                 - 'LazyVerticalGrid': foundation/lazyverticalgrid.md
              - 'Text':
                 - 'BasicTextField': foundation/basictextfield.md
              - 'Shape' : foundation/shape.md
          - 'Material':
              - 'AlertDialog': material/alertdialog.md
              - 'BadgeBox': material/badgedbox.md
              - 'Button': material/button.md
              - 'Card': material/card.md
              - 'Divider': material/divider.md
              - 'CircularProgressIndicator': material/circularprogressindicator.md
              - 'DropdownMenu': material/dropdownmenu.md
              - 'Checkbox': material/checkbox.md
              - 'FloatingActionButton': material/floatingactionbutton.md
              - 'LinearProgressIndicator' : material/linearprogressindicator.md
              - 'ModalBottomSheetLayout': material/modalbottomsheetlayout.md
              - 'ModalDrawer': material/modaldrawer.md
              - 'NavigationRail': material/navigationrail.md
              - 'OutlinedButton': material/button.md
              - 'RadioButton': material/radiobutton.md
              - 'Scaffold': material/scaffold.md
              - 'Slider': material/slider.md
              - 'Snackbar': material/snackbar.md
              - 'Switch': material/switch.md
              - 'Surface': material/surface.md
              - 'Text': foundation/text.md
              - 'TextButton': material/button.md
              - 'TextField': material/textfield.md
              - 'TopAppBar': material/topappbar.md
          - 'UI':
              - 'Layout':
                - 'SubComposeLayout': ui/layout/subcomposelayout.md
          - 'Platform':
              - 'ComposeView': platform/composeview.md
          - 'ViewInterop':
              - 'AndroidView': viewinterop/androidview.md
      - 'Compose Projects': compose_projects.md
      - 'Contributing': contributing.md
      - 'Resources': resources.md

  - 'Compose Multiplatform':
      - 'Desktop': desktop/overview.md
      - 'iOS': ios/overview.md
      - 'Web': web/overview.md
markdown_extensions:
  - smarty
  - codehilite:
      guess_lang: false
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.emoji
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: app/src/main/java/de/jensklingenberg/jetpackcomposeplayground/mysamples/github/
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - admonition

plugins:
  - macros
  - search
  - git-revision-date-localized:
      type: date
  - minify:
      minify_html: true