mkdocs.yml

# Project information
site_url: https://www.56yhz.com
site_name: GreaterWMS Documentation
site_description: GreaterWMS - Open Source Inventory Management
site_author: GreaterWMS

repo_name: GreaterWMS
repo_url: https://www.github.com/GreaterWMS/GreaterWMS

copyright: Copyright © 2016 - 2024 GreaterWMS Team

# Configuration
theme:
  name: material
  custom_dir: material/overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.footnote.tooltips
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  logo: assets/logo.png
  language: en

# Plugins
plugins:
  - offline
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      cache_safe: true
  - glightbox

# Hooks
hooks:
  - material/overrides/hooks/shortcodes.py
  - material/overrides/hooks/translations.py

# Additional configuration
extra:
  annotate:
    json: [.s2]
  generator: false
  analytics:
    provider: google
    property: G-1TRGFWFWSZ
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/GreaterWMS/GreaterWMS
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/greaterwms/greaterwms_backend
    - icon: fontawesome/brands/python
      link: https://www.python.org/
    - icon: fontawesome/brands/vuejs
      link: https://vuejs.org/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCPW1wciGMIEh7CYOdLnsloA
    - icon: fontawesome/brands/bilibili
      link: https://space.bilibili.com/407321291/channel/seriesdetail?sid=776320

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

not_in_nav: |
  /tutorials/**/*.md

# Page tree
nav:
  - Home: index.md
  - Guide:
    - Why GreaterWMS: why_greaterwms.md
    - Sponsors and Supporters: sponsors_and_supporters.md
    - Why Donate?: why_donate.md
    - Please Don't Do That: please_dont_do_that.md
  - Deploy:
    - Software Version Requirements: software_version_requirements.md
    - Server Configuration Recommendations: server_configuration_recommendations.md
    - Win10 X64: win_10.md
    - Centos 7 64-bit Deployment: centos_7.md
    - Ubuntu20 X64: ubuntu_20.md
    - Android Environment: android_environment.md
    - IOS Environment: ios_environment.md
    - Android Apk Signature: android_apk_signature.md
    - Supervisor Process Guarded: supervisor_process_guarded.md
    - Nginx Config: nginx_config.md
    - Executive Summary: executive_summary.md
    - Docker deployment: docker_deployment.md
  - Product:
    - GreaterWMS: greaterwms.md
    - WCS: wcs.md