mkdocs.yml

site_name: SeaTable Developer Manual
site_url: https://developer.seatable.com/
site_author: SeaTable GmbH
site_description: >-
  Official SeaTable Developer Manual.

# Repository
repo_name: seatable/seatable-developer-docs
repo_url: https://github.com/seatable/seatable-developer-docs/

# Copyright
copyright: Copyright © 2022 - 2025 SeaTable GmbH

# Configuration
theme:
  name: material
  features:
    - navigation.footer
    - navigation.tracking
    - navigation.tabs
    - navigation.sections # top-level sections are rendered as groups in the sidebar for viewports above 1220px
    - navigation.indexes # documents can be directly attached to sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - content.code.copy
    - content.code.annotate # offer a comfortable and friendly way to attach arbitrary content to specific sections of code
  custom_dir: overrides

  # icon & favicon
  logo: media/SeaTable256-256.png
  favicon: media/seatable-favicon.ico

  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - git-revision-date-localized
  - include-markdown:
      rewrite_relative_urls: false
  #- redirects:
  #    redirect_maps:
  #      'changelog/server-changelog.md': 'https://seatable.com/changelog/'
  #      'changelog/changelog-for-seatable-professional-server.md': 'https://seatable.com/changelog/'

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/seatable/
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/seatable/seatable-enterprise
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/seatable/
  status:
    new: requires Enterprise Edition
  analytics:
    #provider: matomo
    #site_id: 2
    #provider_url: https://wp-stats.seatable.io/
    
    provider: posthog
    posthog_api_key: phc_wRHcvnLs4nsJLtycPXwtckL4NahZSAlw2uV3d4dm4hT
    posthog_api_host: https://ph.seatable.com
    posthog_ui_host: https://ph.seatable.com

extra_css:
  - stylesheets/extra.css

# Extensions: https://squidfunk.github.io/mkdocs-material/reference/
# PyMdown Extension: https://facelessuser.github.io/pymdown-extensions/extensions/

validation:
  links:
    absolute_links: ignore

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - footnotes
  - toc:
      permalink: true
  - codehilite:
      guess_lang: true
  - pymdownx.details # creates collapsible elements that hide their content
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences: # allows 1) nesting of fences 2) custom fences 3) disable indented code
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.keys # make entering and styling keyboard key presses easier
  - pymdownx.tabbed: # provides a syntax to easily add tabbed Markdown content
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Introduction:
      - index.md
      - Coding for beginners: introduction/coding_for_beginners.md
      - Get support: introduction/get_support.md
  - Scripting:
      - scripts/index.md
      - JavaScript:
          - Objects & Methods:
              - scripts/javascript/objects/index.md
              - Tables: scripts/javascript/objects/tables.md
              - Views: scripts/javascript/objects/views.md
              - Columns: scripts/javascript/objects/columns.md
              - Rows: scripts/javascript/objects/rows.md
              - Links: scripts/javascript/objects/links.md
              - Context: scripts/javascript/objects/context.md
              - Utilities: scripts/javascript/objects/utilities.md
              - Output: scripts/javascript/objects/output.md
          - Examples:
              - scripts/javascript/examples/index.md
              - 1. Add rows: scripts/javascript/examples/auto-add-rows.md
              - 2. Calculate accumulated value: scripts/javascript/examples/calculate-accumulated-value.md
              - 3. Compute attendance statistics: scripts/javascript/examples/compute-attendance-statistics.md
          - Common questions: scripts/javascript/common_questions.md
      - Python:
          - Introduction: scripts/python/introduction.md
          - Objects & Methods:
              - scripts/python/objects/index.md
              - Metadata: scripts/python/objects/metadata.md
              - Context: scripts/python/objects/context.md
              - Tables: scripts/python/objects/tables.md
              - Views: scripts/python/objects/views.md
              - Columns: scripts/python/objects/columns.md
              - Rows: scripts/python/objects/rows.md
              - Links: scripts/python/objects/links.md
              - Files: scripts/python/objects/files.md
              - Big data: scripts/python/objects/big_data.md
              - Accounts: scripts/python/objects/accounts.md
              - Users: scripts/python/objects/users.md
              - Date utilities: scripts/python/objects/date-utils.md
              - Communication utilities: scripts/python/objects/communication-utils.md
          - Examples:
              - scripts/python/examples/index.md
              - 1. Add rows: scripts/python/examples/auto-add-rows.md
              - 2. Calculate accumulated value: scripts/python/examples/calculate-accumulated-value.md
              - 3. Compute attendance statistics: scripts/python/examples/compute-attendance-statistics.md
              - 4. Send emails: scripts/python/examples/send_email.md
              - 5. Generate barcode: scripts/python/examples/generate_barcode.md
              - 6. Generate QR code: scripts/python/examples/generate_qrcode.md
              - 7. Sync MySQL: scripts/python/examples/sync_mysql.md
              - 8. Watch stock price: scripts/python/examples/update_stock_price.md
              - 9. Merge PDF: scripts/python/examples/merge_pdf.md
              - 10. Convert HEIC to PNG: scripts/python/examples/heic_to_png.md
          - Common questions: scripts/python/common_questions.md
      - Query with SQL:
          - Introduction: scripts/sql/introduction.md
          - SQL function reference: scripts/sql/functions.md
  - Plugin Development:
      - plugins/index.md
      - Environments: plugins/environments.md
      - Available methods: plugins/methods.md
  - Client APIs:
      - clients/index.md
      - JavaScript:
          - Introduction: clients/javascript/javascript_api.md
          - Objects & Methods:
              - Metadata: clients/javascript/metadata.md
              - Tables: clients/javascript/tables.md
              - Views: clients/javascript/views.md
              - Columns: clients/javascript/columns.md
              - Rows: clients/javascript/rows.md
              - Links: clients/javascript/links.md
              - SQL: clients/javascript/sql_query.md
              - Constants: clients/javascript/constants.md
          - Examples:
              - File Upload: clients/javascript/examples/file-upload.md
      - Python: clients/python_api.md
      - PHP: clients/php_api.md
      - Ruby: clients/ruby_api.md
## open topics:
# social cards https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
# feedback integration: ...