mkdocs.yml

# MkDocs 1.5+ link / anchor validation. Surfaces broken cross-page anchors as
# warnings so `mkdocs build --strict` catches them in CI. `unrecognized_links`
# stays at INFO because the absolute `/llms.txt` links in `ai_support/ai_llms.md`
# are intentional (they're root-served static files MkDocs can't see in the
# nav graph).
validation:
    links:
        anchors: warn
        absolute_links: info
        unrecognized_links: info
    nav:
        omitted_files: info
        not_found: warn
        absolute_links: info

site_name: JustLend DAO Documentation
site_url: https://docs.justlend.org/
site_description: >-
    Official documentation for JustLend DAO — the largest lending protocol on TRON.
    Compound V2 architecture. Covers supply / borrow / liquidation, sTRX liquid
    staking, Energy Rental, governance, deployed contracts (Mainnet + Nile), public
    OpenAPI, and AI agent integration (llms.txt, contracts.json, JSON ABIs, MCP).
site_author: JustLend DAO

# AI-readability entry files served at the site root.
# They are static (non-Markdown), so MkDocs copies them as-is.
not_in_nav: |
    /llms.txt
    /llms-full.txt
    /robots.txt
    /.well-known/security.txt
    /developers/contracts.json
    /developers/contracts.schema.json
    /developers/apis/agent-acceptance-latest.json
    /developers/abis/*.json

nav:
    - GETTING STARTED:
        - Overview: getting_started/overview.md
        - Concepts:
            - Supply: getting_started/concepts/supply.md
            - Borrow: getting_started/concepts/borrow.md
            - Withdraw: getting_started/concepts/withdraw.md
            - Repay: getting_started/concepts/repay.md
            - Liquidations: getting_started/concepts/liquidations.md
            - Risks: getting_started/concepts/risks.md
            - Staked TRX: getting_started/concepts/staked_trx.md
            - Energy Rental: getting_started/concepts/energy_rental.md
            - SBM V2: getting_started/concepts/SBMV2.md
        - Whitepaper: https://justlend.org/docs/justlend_whitepaper_en.pdf
        - FAQs:
            - Wallet Connection Questions: getting_started/faqs/wallet_connection_questions.md
            - Spending Cap Issue During Transactions: getting_started/faqs/spending_cap_issue.md
            - More Questions: https://support.justlend.org/hc/en-us/sections/360011389611-Questions
    - GOVERNANCE:
        - JIPs: governance/jips.md
        - Tokenomics: governance/tokenomics.md
        - Community Forum: https://forum.justlend.org
    - DEVELOPERS:
        - Contracts Overview: developers/contracts_overview.md
        - JustLend V2: developers/justlend_v2.md
        - Supply and Borrow Market:
            - SBM: developers/supply_and_borrow_market/sbm.md
            - SBM V2: developers/supply_and_borrow_market/sbmV2.md
            - Interest Rate Model: developers/supply_and_borrow_market/interest_rate_model.md
            - Governance: developers/supply_and_borrow_market/governance.md
            - Price Oracle: developers/supply_and_borrow_market/price_oracle.md
            - Comptroller: developers/supply_and_borrow_market/comptroller.md
        - Staked TRX: developers/staked_trx.md
        - Energy Rental: developers/energy_rental.md
        - Deployed Contracts: developers/deployed_contracts.md
        - Resolving Contract Addresses: developers/resolving_contract_addresses.md
        - APIs: developers/apis.md
        - ABI Files: developers/abis/index.md
        - Common Pitfalls: developers/common_pitfalls.md
    - AI SUPPORT:
        - Overview: ai_support/index.md
        - AI / LLMs: ai_support/ai_llms.md
        - MCP Server: ai_support/mcp_server.md
        - JustLend Skills: ai_support/justlend_skills.md
        - CLI and V2 SDK: ai_support/cli_and_sdk.md
        - AI Docs for Agents:
            - Index: documents/aidocs/index.md
            - Source of Truth: documents/aidocs/source_of_truth.md
            - Quickstart: documents/aidocs/quickstart.md
            - Market Data: documents/aidocs/market_data.md
            - Account Positions: documents/aidocs/account_position.md
            - Lending Workflows: documents/aidocs/supply_borrow_repay_withdraw.md
            - sTRX Staking: documents/aidocs/strx_staking.md
            - Energy Rental: documents/aidocs/energy_rental.md
            - MCP Safety: documents/aidocs/mcp_safety.md
            - Common Questions: documents/aidocs/common_questions.md
            - AI Glossary: documents/aidocs/glossary.md
            - MCP Tool Catalog: documents/aidocs/mcp_tools.md
    - RESOURCES:
        - Community:
            - Links: resources/community/links.md
            - Wallet Integration Cooperation: resources/community/wallet_integration_cooperation.md
        - Risk Warning: resources/risk_warning.md
        - Glossary: resources/glossary.md
        - Audits:
            - Supply & Borrow: https://justlend.org/docs/justlend_audit_en.pdf
            - Staked TRX: https://justlend.org/docs/justlend_strx_audit_en.pdf
        - Terms of Service:
            - Terms of Service: https://justlend.org/docs/JustLend_Terms_of_Use_en.pdf
            - Privacy Policy: https://justlend.org/docs/JustLend_Privacy_Policy_en.pdf


theme:
    name: material
    custom_dir: docs/overrides
    features:
        - navigation.sections
        - toc.integrate
        - search.highlight
        - search.suggest
        - content.code.annotate
        - content.tooltips

extra_css:
        - stylesheets/extra.css
        - stylesheets/hide_elements.css

# Build-time hooks. `copy_dotfiles` mirrors `docs/.well-known/` and any other
# dotfile-rooted directory into the site output — MkDocs's default file walker
# skips dotfile directories, which would otherwise 404 /.well-known/security.txt.
hooks:
      - hooks/copy_dotfiles.py

plugins:
      - search
      - swagger-ui-tag # 添加这个插件
      # Per-page last-updated, sourced from git commit metadata.
      # Requires the GitHub Actions checkout step to use `fetch-depth: 0`.
      - git-revision-date-localized:
          enable_creation_date: false
          fallback_to_build_date: true
          type: iso_date
      # Redirects: legacy hyphenated URLs → current underscore URLs.
      # MkDocs generates static HTML at the old paths with <meta http-equiv="refresh">
      # plus <link rel="canonical"> pointing at the new path. Browsers and major
      # crawlers (Google/Bing/ClaudeBot/GPTBot) treat this as equivalent to a 301.
      # For true HTTP 301s, replicate this mapping in a Cloudflare Page Rule.
      - redirects:
          redirect_maps:
              # Getting Started
              'getting-started/overview.md': 'getting_started/overview.md'
              'getting-started/concepts/supply.md': 'getting_started/concepts/supply.md'
              'getting-started/concepts/borrow.md': 'getting_started/concepts/borrow.md'
              'getting-started/concepts/withdraw.md': 'getting_started/concepts/withdraw.md'
              'getting-started/concepts/repay.md': 'getting_started/concepts/repay.md'
              'getting-started/concepts/liquidations.md': 'getting_started/concepts/liquidations.md'
              'getting-started/concepts/risks.md': 'getting_started/concepts/risks.md'
              'getting-started/concepts/staked-trx.md': 'getting_started/concepts/staked_trx.md'
              'getting-started/concepts/energy-rental.md': 'getting_started/concepts/energy_rental.md'
              'getting-started/faqs/wallet-connection-questions.md': 'getting_started/faqs/wallet_connection_questions.md'
              'getting-started/faqs/spending-cap-issue.md': 'getting_started/faqs/spending_cap_issue.md'
              # Developers
              'developers/contracts-overview.md': 'developers/contracts_overview.md'
              'developers/deployed-contracts.md': 'developers/deployed_contracts.md'
              'developers/staked-trx.md': 'developers/staked_trx.md'
              'developers/energy-rental.md': 'developers/energy_rental.md'
              # Developers / Supply and Borrow Market
              'developers/supply-and-borrow-market/sbm.md': 'developers/supply_and_borrow_market/sbm.md'
              'developers/supply-and-borrow-market/interest-rate-model.md': 'developers/supply_and_borrow_market/interest_rate_model.md'
              'developers/supply-and-borrow-market/governance.md': 'developers/supply_and_borrow_market/governance.md'
              'developers/supply-and-borrow-market/price-oracle.md': 'developers/supply_and_borrow_market/price_oracle.md'
              'developers/supply-and-borrow-market/comptroller.md': 'developers/supply_and_borrow_market/comptroller.md'
              # Legacy endpoint-level pages (API reference is now a single Swagger UI page)
              'developers/supply-and-borrow-market/get-market-mining-apy-information.md': 'developers/apis.md'
              # AI Support
              'ai-support/ai-llms.md': 'ai_support/ai_llms.md'
              'ai-support/mcp-server.md': 'ai_support/mcp_server.md'
              'ai-support/justlend-skills.md': 'ai_support/justlend_skills.md'
              # Resources
              'resources/risk-warning.md': 'resources/risk_warning.md'
              'resources/community/wallet-integration-cooperation.md': 'resources/community/wallet_integration_cooperation.md'

markdown_extensions:
        - admonition
        - codehilite
        - toc:
            permalink: true
            toc_depth: 3
        - pymdownx.arithmatex
        - pymdownx.tilde
        - pymdownx.tasklist
        - pymdownx.superfences