mkdocs.yml

site_name: java-tron
site_url: https://tronprotocol.github.io/documentation-en/
repo_url: https://github.com/tronprotocol/documentation-en
repo_name: tronprotocol/documentation-en
edit_uri: edit/master/docs/

nav:
  - Home: index.md
  - Get started:
      - Overview: getting_started/index.md
      - Getting started with java-tron: getting_started/getting_started_with_javatron.md
  - Operate a node:
      - Overview: using_javatron/index.md
      - Deploy a node: using_javatron/installing_javatron.md
      - Node configuration: using_javatron/configuration.md
      - Node logging: using_javatron/logging.md
      - Lite FullNode: using_javatron/litefullnode.md
      - Private network: using_javatron/private_network.md
      - Network connection: using_javatron/connecting_to_tron.md
      - Database configuration: architecture/database.md
      - Event subscription: architecture/event.md
      - Node monitoring: using_javatron/metrics.md
      - Backup and restore: using_javatron/backup_restore.md
      - Node maintenance toolkit: using_javatron/toolkit.md
  - API reference:
      - Overview: api/index.md
      - HTTP API: api/http/index.md
      - gRPC API: api/rpc/index.md
      - JSON-RPC API: api/json-rpc/index.md
      - Machine-readable definitions: api/interface-definitions.md
  - wallet-cli:
      - Overview: clients/wallet-cli/index.md
      - Java CLI:
          - Overview: clients/wallet-cli/java/index.md
          - Guides:
              - Overview: clients/wallet-cli/java/guide/index.md
              - Getting started: clients/wallet-cli/java/guide/getting-started.md
              - Command-line operation flow: clients/wallet-cli/java/guide/command-flow.md
          - Concepts:
              - Overview: clients/wallet-cli/java/concepts/index.md
              - Resources, energy, and shares: clients/wallet-cli/java/concepts/resources.md
              - Stake 1.0 and Stake 2.0: clients/wallet-cli/java/concepts/staking-models.md
              - Multi-signature concepts: clients/wallet-cli/java/concepts/multisig.md
          - Command reference:
              - Command index: clients/wallet-cli/java/commands/index.md
              - Wallet management: clients/wallet-cli/java/commands/wallet.md
              - Account commands: clients/wallet-cli/java/commands/account.md
              - Network commands: clients/wallet-cli/java/commands/network.md
              - TRC10 tokens: clients/wallet-cli/java/commands/transfer-trc10.md
              - USDT and TRC20 transfers: clients/wallet-cli/java/commands/usdt.md
              - Staking (Stake 2.0): clients/wallet-cli/java/commands/stake-v2.md
              - Staking (Stake 1.0, legacy): clients/wallet-cli/java/commands/stake-v1-legacy.md
              - Resource prices and memo fee: clients/wallet-cli/java/commands/resources.md
              - Voting, rewards, and witnesses: clients/wallet-cli/java/commands/vote-reward.md
              - Smart contracts: clients/wallet-cli/java/commands/contract.md
              - Proposals: clients/wallet-cli/java/commands/proposals.md
              - Exchange (Bancor): clients/wallet-cli/java/commands/exchange.md
              - TRON-DEX market: clients/wallet-cli/java/commands/dex.md
              - Multi-signature: clients/wallet-cli/java/commands/multisig.md
              - GasFree transfers: clients/wallet-cli/java/commands/gasfree.md
              - Chain data and utilities: clients/wallet-cli/java/commands/chain-data.md
          - Configuration reference: clients/wallet-cli/java/reference/config.md
      - TypeScript / npm CLI:
          - Overview: clients/wallet-cli/typescript/index.md
          - Guides:
              - Overview: clients/wallet-cli/typescript/guide/index.md
              - Getting started: clients/wallet-cli/typescript/guide/getting-started.md
              - Sending TRX and tokens: clients/wallet-cli/typescript/guide/send-tokens.md
              - Staking and resources: clients/wallet-cli/typescript/guide/stake-and-resources.md
              - Ledger hardware wallet: clients/wallet-cli/typescript/guide/ledger.md
              - Scripting wallet-cli: clients/wallet-cli/typescript/guide/scripting.md
          - Concepts:
              - Overview: clients/wallet-cli/typescript/concepts/index.md
              - Networks: clients/wallet-cli/typescript/concepts/networks.md
              - Accounts and HD wallets: clients/wallet-cli/typescript/concepts/accounts-and-hd.md
              - Energy and Bandwidth: clients/wallet-cli/typescript/concepts/energy-bandwidth.md
              - Security model: clients/wallet-cli/typescript/concepts/security.md
          - Command reference:
              - Command index: clients/wallet-cli/typescript/commands/index.md
              - Imports: clients/wallet-cli/typescript/commands/import/index.md
              - Transactions: clients/wallet-cli/typescript/commands/tx/index.md
              - Accounts: clients/wallet-cli/typescript/commands/account/index.md
              - Chain queries: clients/wallet-cli/typescript/commands/chain/index.md
              - Permissions: clients/wallet-cli/typescript/commands/permission/index.md
              - Tokens: clients/wallet-cli/typescript/commands/token/index.md
              - Contacts: clients/wallet-cli/typescript/commands/contact/index.md
              - Contracts: clients/wallet-cli/typescript/commands/contract/index.md
              - GasFree: clients/wallet-cli/typescript/commands/gasfree/index.md
              - Staking: clients/wallet-cli/typescript/commands/stake/index.md
              - Voting: clients/wallet-cli/typescript/commands/vote/index.md
              - Rewards: clients/wallet-cli/typescript/commands/reward/index.md
              - Proposals: clients/wallet-cli/typescript/commands/proposal/index.md
              - Witnesses: clients/wallet-cli/typescript/commands/witness/index.md
              - TRC10 assets: clients/wallet-cli/typescript/commands/asset/index.md
              - Exchange: clients/wallet-cli/typescript/commands/exchange/index.md
              - Messages: clients/wallet-cli/typescript/commands/message/index.md
              - Typed data: clients/wallet-cli/typescript/commands/typed-data/index.md
              - x402: clients/wallet-cli/typescript/commands/x402/index.md
              - B.AI: clients/wallet-cli/typescript/commands/bai/index.md
              - ERC-8004 Agent identities: clients/wallet-cli/typescript/commands/8004/index.md
              - Encoding: clients/wallet-cli/typescript/commands/encoding/index.md
              - Addresses: clients/wallet-cli/typescript/commands/address/index.md
          - Machine interface: clients/wallet-cli/typescript/machine-interface.md
          - Troubleshooting: clients/wallet-cli/typescript/troubleshooting.md
  - Understand the protocol:
      - Overview: mechanism-algorithm/index.md
      - DPoS consensus: mechanism-algorithm/dpos.md
      - Super Representatives: mechanism-algorithm/sr.md
      - Account model: mechanism-algorithm/account.md
      - Resource model: mechanism-algorithm/resource.md
      - System contracts: mechanism-algorithm/system-contracts.md
      - Account permission management: mechanism-algorithm/multi-signatures.md
  - Contribute to java-tron:
      - Overview: developers/index.md
      - Developer guide: developers/java-tron.md
      - Configure the IDE: developers/run-in-idea.md
      - Development example: developers/demo.md
      - CI workflows: developers/workflows.md
      - Issue workflow: developers/issue-workflow.md
      - Network governance: developers/governance.md
      - TIPs workflow: developers/tip-workflow.md
      - TIP index: developers/tips.md
      - Core modules: developers/code-structure.md
      - ChainBase deep dive: developers/chainbase.md
      - P2P network deep dive: developers/network.md
  - Build DApps:
      - Overview: contracts/index.md
      - Smart contracts: contracts/contract.md
      - Developer tools: contracts/tools.md
  - Releases:
      - Overview: releases/index.md
      - Upgrade a node: releases/upgrade-instruction.md
      - Verify release integrity: releases/signature_verification.md
      - Release history: releases/versions/index.md
  - Appendix:
      - Glossary: glossary.md

# Detailed reference pages remain built, searchable, and linked from their indexes,
# but do not expand the primary navigation.
not_in_nav: |
  api/http/*/*.md
  api/rpc/*/*.md
  api/json-rpc/*/*.md
  clients/wallet-cli/typescript/commands/*.md
  clients/wallet-cli/typescript/commands/*/*.md
  !clients/wallet-cli/typescript/commands/index.md
  !clients/wallet-cli/typescript/commands/*/index.md
  clients/wallet-cli/typescript/troubleshooting/legacy-derivation-recovery.md
  releases/versions/*.md
  !releases/versions/index.md

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  features:
    - navigation.sections  # Enable grouping in the left navigation bar
    - navigation.indexes  # Allow sections to use index.md as their landing page
    - navigation.footer
    - navigation.tracking  # Update URL anchor while scrolling
    - toc.follow  # Right-side TOC highlights the current section
    # - toc.integrate  # Disabled to restore the standard right-side TOC
    - search.highlight  # Highlight matching content during search
    - search.suggest  # Show suggestions during search
    - search.share  # Share button in search box copies URL with active query
    - content.code.annotate  # Code block annotations
    - content.code.copy  # Copy button in the top-right of every code block
    - content.tooltips  # Tooltips in content
    - content.action.edit  # Per-page "Edit this page" button
    - content.action.view  # Per-page "View source" button
  palette:
    primary: custom  # Primary color
    accent: custom  # Accent color
  font:
    text: Roboto  # Body text font
    code: Roboto Mono  # Code font

extra_javascript:
  - javascripts/toc.js
  - javascripts/mathjax-sri.js

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list  # Required by homepage grid cards
  - footnotes
  - md_in_html  # Required by homepage grid cards
  - codehilite
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex
  - pymdownx.tilde
  - pymdownx.tasklist
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - git-revision-date-localized:
      locale: en
      type: date
      fallback_to_build_date: true