mkdocs.yml

site_name: Msgport Documentation
site_url: https://msgport.ringdao.com/docs/
site_description: "This is the official documentation for the Msgport, which is a programmable cross-chain messaging protocol. This site covers the design, usage and integration guide for Msgport."
copyright: Copyright © Msgport
repo_name: msgport-docs
edit_uri: https://github.com/ringecosystem/msgport-docs/edit/main/docs
use_directory_urls: false
site_dir: site/docs
theme:
  name: material
  logo: resource/pics/msgport-logo.svg
  favicon: resource/pics/favicon.png
  font:
    text: 0xProto Nerd Font
    code: 0xProto Nerd Font
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.path
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  language: en
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

extra:
  generator: false
  homepage: https://msgport.ringdao.com
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ringecosystem/msgport
    - icon: fontawesome/brands/telegram
      link: https://t.me/msgport
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/msgport_xyz
  extra:
  analytics:
    provider: google
    property: G-4FS95WZ91T
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/ringecosystem/msgport-docs/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

extra_css:
  - resource/stylesheets/extra.css

extra_javascript:
  - resource/script/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

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

plugins:
  - search
  - meta-descriptions:
      enable_checks: true
      max_length: 500
      trim: true
  - git-authors
  - git-revision-date-localized:
      fallback_to_build_date: false
      enable_creation_date: true
  - redirects:
      redirect_maps:
        "learn/networks.md": 'build/networks.md'
        "learn/interfaces.md": "build/interfaces.md"
        "learn/workflow.md": "build/workflow.md"
        "learn/api.md": "build/api.md"
        "learn/scan.md": "build/scan.md"
        "build/use-cases/overview.md": "learn/use-cases/overview.md"
        "build/use-cases/order-xclearing.md": "learn/use-cases/order-xclearing.md"
        "build/use-cases/xtoken.md": "learn/use-cases/xtoken.md"
        "build/use-cases/xaccount.md": "learn/use-cases/xaccount.md"
        "build/use-cases/xdao.md": "learn/use-cases/xdao.md"
        "build/tutorial/script-demo.md": "build/tutorial/examples.md"
nav:
  - Learn:
      - What is Msgport?: "index.md"
      - Architecture: "learn/architecture.md"
      - Messaging Protocols:
          - Overview: "learn/messaging-protocols/overview.md"
          - ORMP Protocol: "learn/messaging-protocols/ormp.md"
          - XCMP Protocol: "learn/messaging-protocols/xcmp.md"
          - LCMP Protocol: "learn/messaging-protocols/lcmp.md"
      - Use Cases:
        - Overview: "learn/use-cases/overview.md"
        - Cross-chain Abstract Account: "learn/use-cases/xaccount.md"
        - Cross-chain DAOs: "learn/use-cases/xdao.md"
        - Cross-chain Tokens: "learn/use-cases/xtoken.md"
        - Order Clearing: "learn/use-cases/order-xclearing.md"
      - Glossary: "learn/glossary.md"
      - FAQ: "learn/faq.md"
  - Developers:
      - Supported Networks: "build/networks.md"
      - Core Interfaces: "build/interfaces.md"
      - Integration Guide: "build/workflow.md"
      - Message Scan: "build/scan.md"
      - API Documentation: "build/api.md"
      - Tutorial:
        - Sending Messages:        
          - Using Remix: "build/tutorial/remix-demo.md"
          - Using Foundry: "build/tutorial/foundry-demo.md"
        - Validating Messages: "build/tutorial/validation.md"
        - Explore More Examples: "build/tutorial/examples.md"
  - Community: 
      - Ring DAO: "community/ringdao.md"
      - Bug Bounty: "community/bug-bounty.md"