mkdocs.yml

site_name: PythonNative
site_description: Cross-platform native UI toolkit for Android and iOS
site_author: Owen Carey
site_url: https://docs.pythonnative.com/
repo_url: https://github.com/pythonnative/pythonnative
repo_name: pythonnative/pythonnative
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo-256.jpg
  favicon: assets/favicon.png
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pythonnative/pythonnative
      name: PythonNative on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pythonnative/
      name: PythonNative on PyPI

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Concepts:
    - Mental Model: concepts/mental-model.md
    - Architecture: concepts/architecture.md
    - Components: concepts/components.md
    - Hooks: concepts/hooks.md
    - Lifecycle: concepts/lifecycle.md
    - Reconciliation: concepts/reconciliation.md
    - Native Views: concepts/native-views.md
  - Guides:
    - Android: guides/android.md
    - iOS: guides/ios.md
    - Navigation: guides/navigation.md
    - Styling: guides/styling.md
    - Native Modules: guides/native-modules.md
    - Hot Reload: guides/hot-reload.md
    - Error Boundaries: guides/error-boundaries.md
    - Testing: guides/testing.md
  - Examples:
    - Overview: examples.md
    - Hello World: examples/hello-world.md
    - Counter: examples/counter.md
    - Forms: examples/forms.md
    - Lists: examples/lists.md
    - Navigation: examples/navigation.md
  - API Reference:
    - Package: api/pythonnative.md
    - Components: api/components.md
    - Hooks: api/hooks.md
    - Element: api/element.md
    - Page: api/page.md
    - Reconciler: api/reconciler.md
    - Style: api/style.md
    - Navigation: api/navigation.md
    - Native modules: api/native_modules.md
    - Native views: api/native_views.md
    - Hot reload: api/hot_reload.md
    - Utilities: api/utils.md
    - CLI (pn): api/cli.md
    - Component properties: api/component-properties.md
  - Meta:
    - Style Guide: meta/style-guide.md
    - Contributing: meta/contributing.md
    - FAQ: meta/faq.md
    - Troubleshooting: meta/troubleshooting.md
    - Changelog: meta/changelog.md

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: google
            docstring_section_style: table
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            show_bases: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            filters: ["!^_"]
  - social:
      cards_layout_options:
        background_color: "#ffffff"
        color: "#000000"

extra_css:
  - styles/brand.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - codehilite
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 4
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: pythonnative
      repo: pythonnative
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

watch:
  - src/pythonnative