app-exchange/mkdocs.yml at develop · LedgerHQ/app-exchange · 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
---
site_name: Ledger Swap documentation
# site_url: https://ethereum-plugin-sdk.ledger.com
site_description: Documentation for Ledger Swap
theme:
  logo: img/Ledger-logo-696.webp
  favicon: img/Ledger-logo-696.webp
  name: material
  highlightjs: true
  hljs_languages:
    - yaml
  features:
    - navigation.indexes
    - navigation.expand

plugins:
  - search
  - mermaid2:
      arguments:
        theme: 'dark'
        themeVariables:
          primaryColor: '#BB2528'
          primaryTextColor: '#fff'
          primaryBorderColor: '#7C0000'
          lineColor: '#F8B229'
          secondaryColor: '#006100'
          tertiaryColor: '#fff'

markdown_extensions:
  - admonition
  - pymdownx.snippets:
      check_paths: true
      base_path:
        - .
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      preserve_tabs: true
      custom_fences:
        # Mermaid diagrams
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Introduction: index.md
  - Enabling the SWAP on your application:
      - Enabling the SWAP on your application: walkthrough/index.md
      - Prerequisite: walkthrough/prerequisite.md
      - Running an existing SWAP test: walkthrough/run_first_test.md
      - First compilation with the standard SWAP:
          - First compilation with the standard SWAP: walkthrough/enable_the_swap_compilation/index.md
          - For C applications: walkthrough/enable_the_swap_compilation/c.md
          - For Rust applications: walkthrough/enable_the_swap_compilation/rust.md
      - Creating a basic SWAP test for you coin: walkthrough/enable_standard_app.md
      - Code the handlers: walkthrough/code_the_handlers.md
  - Technical Information:
      - Technical Information: technical_information/index.md
      - Sequence diagram: technical_information/diagram.md
      - Exchange Protocol API: technical_information/protocol.md
      - FUND and SELL flows: technical_information/fund_and_sell.md
      - Crypto Asset List (CAL): technical_information/cal.md
      - BSS safety in coin applications: technical_information/bss.md
      - Coin Application API:
          - Coin Application API: technical_information/coin_application_api/index.md
          - Coin application entry point: technical_information/coin_application_api/entry_point.md
          - CHECK_ADDRESS: technical_information/coin_application_api/swap_handle_check_address.md
          - GET_PRINTABLE_AMOUNT: technical_information/coin_application_api/swap_handle_get_printable_amount.md
          - SIGN_TRANSACTION:
              - SIGN_TRANSACTION: technical_information/coin_application_api/sign_transaction/index.md
              - Copy Transaction Parameters: technical_information/coin_application_api/sign_transaction/swap_copy_transaction_parameters.md
              - UI bypass: technical_information/coin_application_api/sign_transaction/ui_bypass.md
              - Error codes: technical_information/coin_application_api/sign_transaction/error_codes.md
      - The DALE tool: technical_information/dale.md

watch:
  - mkdocs.yml
  - docs/
  - test/
  - src/