documentation-zh/mkdocs.yml at master · tronprotocol/documentation-zh · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
site_name: java-tron
site_url: https://tronprotocol.github.io/documentation-zh/
repo_url: https://github.com/tronprotocol/documentation-zh

nav:
    - Home: index.md
    - java-tron入门:
        - 入门: getting_started/getting_started_with_javatron.md
    - 使用java-tron:
        - 部署: using_javatron/installing_javatron.md
        - 备份和恢复: using_javatron/backup_restore.md
        - 轻节点: using_javatron/litefullnode.md
        - 私链网络: using_javatron/private_network.md
        - 事件订阅: architecture/event.md
        - 数据库配置: architecture/database.md
        - 网络连接: using_javatron/connecting_to_tron.md
        - 节点监控: using_javatron/metrics.md
        - 节点维护工具: using_javatron/toolkit.md
    - API接口:
        - HTTP 接口: api/http.md
        - gRPC 接口: api/rpc.md
        - jsonRPC 接口: api/json-rpc.md
    - 核心协议:
        - 波场共识: mechanism-algorithm/dpos.md
        - 超级代表: mechanism-algorithm/sr.md
        - 账户模型: mechanism-algorithm/account.md
        - 资源模型: mechanism-algorithm/resource.md
        - 智能合约: contracts/contract.md
        - 系统合约: mechanism-algorithm/system-contracts.md
        - 去中心化交易所: mechanism-algorithm/dex.md
        - 账户权限管理: mechanism-algorithm/multi-signatures.md
    - java-tron开发:
        - 开发者指南: developers/java-tron.md
        - TIPs工作流程: developers/tips.md
        - Issue工作流程: developers/issue-workflow.md
        - 治理流程: developers/governance.md
        - 配置IDE开发环境: developers/run-in-idea.md
        - 开发示例: developers/demo.md
        - 核心模块: developers/code-structure.md
    - Dapp开发:
        - 工具: contracts/tools.md
    - 客户端:
        - wallet-cli: clients/wallet-cli.md
    - 版本发布:
        - 新版本部署手册: releases/upgrade-instruction.md
        - 一致性检验: releases/signature_verification.md
        - 历史版本: releases/history.md
    - 附录:
        - 术语表: glossary.md


theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.sections  # 启用左侧导航栏的分组
    - navigation.footer
    - toc.integrate
    - search.highlight  # 搜索时高亮匹配内容
    - search.suggest  # 搜索时显示建议
    - content.code.annotate  # 代码块注释
    - content.tooltips  # 内容中的工具提示
  palette:
    primary: custom  # 主色调
    accent: custom  # 强调色
  font:
    text: Roboto  # 正文字体
    code: Roboto Mono  # 代码字体

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

extra_css:
    - stylesheets/extra.css

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

plugins:
  - search:
     separator: '[\s\u200b\-]'
  - exclude:
      glob:
        - clients/tron-grid.md
        - contracts/trc20.md
        - contracts/tvm.md
        - developers/contribution.md
        - developers/gpg.md
        - developers/incentives.md
        - developers/resources.md
        - faq/index.md
        - introduction/index.md
        - introduction/overview.md
        - mechanism-algorithm/shielded-TRC20-contract.md
        - mechanism-algorithm/trc10.md