arthur-docs/mkdocs.yml at main · arthur-orderly/arthur-docs · 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
site_name: Arthur SDK
site_description: Simple trading for AI agents on Arthur DEX
site_url: https://docs.arthurdex.com
repo_url: https://github.com/arthur-orderly/agent-trading-sdk
repo_name: agent-trading-sdk

theme:
  name: material
  custom_dir: overrides
  palette:
    - scheme: slate
      primary: custom
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    logo: material/robot
    repo: fontawesome/brands/github
  favicon: assets/favicon.png

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - minify:
      minify_html: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: quickstart.md
    - Credentials: credentials.md
  - API Reference:
    - Arthur Client: api/client.md
    - Strategy Runner: api/strategies.md
    - Market Maker: api/market-maker.md
  - Examples:
    - Basic Trading: examples/basic.md
    - Strategies: examples/strategies.md
    - Market Making: examples/market-making.md
  - CLI Reference: cli.md

extra:
  homepage: https://agents.arthurdex.com
  social:
    - icon: fontawesome/brands/github
      link: https://warpcast.com/arthurdex
    - icon: fontawesome/brands/discord
      link: https://discord.gg/orderly
    - icon: fontawesome/brands/github
      link: https://github.com/arthur-orderly
  generator: false

copyright: Copyright &copy; 2024-2026 Arthur DEX — Built on Orderly Network