Skip to content

Commit b2b6669

Browse files
martinkersnerbryan-bisonai
martinkersner
and
bryan-bisonai
authored
Update documentation v0.2.0 (#11)
* feat: include docs for all exchanges in v0.2.0 * feat: include new docs to nav * feat: include sections * Add homepage url * Add favicon and logo * add autohid feature * add dismiss feature * Configure settings to improve the user experience. * Add Google Analytics and feedback form feature. Note: I haven't added the URL to the feedback form yet. --------- Co-authored-by: bryan <[email protected]>
1 parent fe3f064 commit b2b6669

File tree

9 files changed

+110
-28
lines changed

9 files changed

+110
-28
lines changed

‎docs/assets/images/favicon.png

345 Bytes
Loading

‎docs/assets/logo.png

2.91 KB
Loading

‎docs/bithumb.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Bithumb Client
2+
3+
::: datamaxi.bithumb
4+
options:
5+
show_submodules: true
6+
show_source: false

‎docs/bybit.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Bybit Client
2+
3+
::: datamaxi.bybit
4+
options:
5+
show_submodules: true
6+
show_source: false

‎docs/coinone.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Coinone Client
2+
3+
::: datamaxi.coinone
4+
options:
5+
show_submodules: true
6+
show_source: false

‎docs/huobi.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Huobi Client
2+
3+
::: datamaxi.huobi
4+
options:
5+
show_submodules: true
6+
show_source: false

‎docs/okx.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Okx Client
2+
3+
::: datamaxi.okx
4+
options:
5+
show_submodules: true
6+
show_source: false

‎docs/upbit.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Upbit Client
2+
3+
::: datamaxi.upbit
4+
options:
5+
show_submodules: true
6+
show_source: false

‎mkdocs.yml

Lines changed: 74 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: DataMaxi+
1+
site_name: ""
22

33
repo_name: bisonai/datamaxi-python
44
repo_url: https://github.com/bisonai/datamaxi-python
@@ -20,44 +20,90 @@ plugins:
2020
merge_init_into_class: true
2121

2222
markdown_extensions:
23-
- toc:
24-
permalink: true
25-
- codehilite
26-
- pymdownx.highlight:
27-
use_pygments: true
28-
- pymdownx.superfences
23+
- toc:
24+
permalink: true
25+
- codehilite
26+
- pymdownx.highlight:
27+
use_pygments: true
28+
- pymdownx.superfences
2929

3030
nav:
3131
- Main: index.md
3232
- API: api.md
33-
- Binance: binance.md
33+
- CEX:
34+
- Binance: binance.md
35+
- Bithumb: bithumb.md
36+
- Bybit: bybit.md
37+
- Coinone: coinone.md
38+
- Huobi: huobi.md
39+
- Okx: okx.md
40+
- Upbit: upbit.md
3441
- Defillama: defillama.md
35-
- Naver Trend: naver-trend.md
36-
- Google Trend: google-trend.md
42+
- Trend:
43+
- Naver Trend: naver-trend.md
44+
- Google Trend: google-trend.md
3745

3846
theme:
3947
name: material
48+
logo: /assets/logo.png
49+
favicon: /assets/images/favicon.png
4050
icon:
4151
repo: fontawesome/brands/github
4252
palette:
43-
- media: "(prefers-color-scheme)"
44-
toggle:
45-
icon: material/brightness-auto
46-
name: Switch to light mode
47-
- media: "(prefers-color-scheme: light)"
48-
scheme: default
49-
primary: teal
50-
accent: purple
51-
toggle:
52-
icon: material/weather-sunny
53-
name: Switch to dark mode
54-
- media: "(prefers-color-scheme: dark)"
55-
scheme: slate
56-
primary: black
57-
accent: lime
58-
toggle:
59-
icon: material/weather-night
60-
name: Switch to system preference
53+
- media: "(prefers-color-scheme)"
54+
toggle:
55+
icon: material/brightness-auto
56+
name: Switch to light mode
57+
- media: "(prefers-color-scheme: light)"
58+
scheme: default
59+
primary: teal
60+
accent: purple
61+
toggle:
62+
icon: material/weather-sunny
63+
name: Switch to dark mode
64+
- media: "(prefers-color-scheme: dark)"
65+
scheme: slate
66+
primary: black
67+
accent: lime
68+
toggle:
69+
icon: material/weather-night
70+
name: Switch to system preference
71+
features:
72+
- header.autohide
73+
- announce.dismiss
74+
- navigation.footer
75+
- navigation.path
6176

6277
watch:
6378
- datamaxi
79+
80+
extra:
81+
homepage: https://datamaxiplus.com/
82+
analytics:
83+
provider: google
84+
property: G-X2HTG9B39J
85+
feedback:
86+
title: Was this page helpful?
87+
ratings:
88+
- icon: material/emoticon-happy-outline
89+
name: This page was helpful
90+
data: 1
91+
note: >-
92+
Thanks for your feedback!
93+
- icon: material/emoticon-sad-outline
94+
name: This page could be improved
95+
data: 0
96+
note: >-
97+
Thanks for your feedback! Help us improve this page by
98+
using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
99+
social:
100+
- icon: fontawesome/brands/github
101+
link: https://github.com/Bisonai
102+
- icon: fontawesome/brands/x-twitter
103+
link: https://twitter.com/datamaxiplus
104+
- icon: fontawesome/brands/telegram
105+
link: https://t.me/datamaxiplus
106+
- icon: fontawesome/brands/medium
107+
link: https://medium.com/@datamaxiplus
108+
109+
copyright: Copyright &copy; 2024 BISONAI PTE. LTD.

0 commit comments

Comments
 (0)