Design updates and clean up (#20)

* 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.

* remove DataMaxi+ API link from the doc

* increase the quality of favicon

* reduce the main logo size

* change the copyright name

* Change primary color and remove system setting mode

---------

Co-authored-by: Martin Kersner <[email protected]>

README.md

@@ -38,8 +38,8 @@ If you are interested to try DataMaxi+, you can simply sign up for DataMaxi+ thr
 | `base_url`         | If `base_url` is not provided, it defaults to `api.datamaxiplus.com`.                 |
 | `timeout`          | Number of seconds to wait for a server response. By default requests do not time out. |
 | `proxies`          | Proxy through which the request is queried                                            |
-| `show_limit_usage` | Return response as dictionary including `"limit_usage"` and `"data"` keys   |
-| `show_header`      | Return response as dictionary including `"header"` and `"data"` keys        |
+| `show_limit_usage` | Return response as dictionary including `"limit_usage"` and `"data"` keys             |
+| `show_header`      | Return response as dictionary including `"header"` and `"data"` keys                  |
 
 ### Environment Variables
 
@@ -123,7 +123,6 @@ python3 -m pytest tests/
 ## Links
 
 - [DataMaxi+](https://datamaxiplus.com/)
-- [DataMaxi+ API](https://api.datamaxiplus.com/)
 - [DataMaxi+ API Documentation](https://docs.datamaxiplus.com/)
 
 ## Contributing

docs/extra.css

@@ -0,0 +1,26 @@
+/* For light mode */
+[data-md-color-scheme="default"] {
+  --md-primary-fg-color: #cba202;
+  .md-header {
+    background-color: #5e7283;
+  }
+  .md-main {
+    background-color: #ffffff;
+  }
+}
+
+/* For dark mode */
+[data-md-color-scheme="slate"] {
+  --md-primary-fg-color: #fed535;
+  .md-header {
+    background-color: #242526;
+  }
+  .md-main {
+    background-color: #1b1b1d;
+  }
+}
+
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 0.9rem;
+}

mkdocs.yml

@@ -50,24 +50,20 @@ theme:
   icon:
     repo: fontawesome/brands/github
   palette:
-    - media: "(prefers-color-scheme)"
-      toggle:
-        icon: material/brightness-auto
-        name: Switch to light mode
     - media: "(prefers-color-scheme: light)"
       scheme: default
-      primary: teal
-      accent: purple
+      primary: custom
+      accent: custom
       toggle:
         icon: material/weather-sunny
-        name: Switch to dark mode
+        name: Switch to light mode
     - media: "(prefers-color-scheme: dark)"
       scheme: slate
-      primary: black
-      accent: lime
+      primary: custom
+      accent: custom
       toggle:
         icon: material/weather-night
-        name: Switch to system preference
+        name: Switch to light mode
   features:
     - header.autohide
     - announce.dismiss
@@ -77,8 +73,10 @@ theme:
 watch:
   - datamaxi
 
+extra_css: [extra.css]
+
 extra:
-  homepage: https://datamaxiplus.com/
+  homepage:
   analytics:
     provider: google
     property: G-X2HTG9B39J
@@ -106,4 +104,4 @@ extra:
     - icon: fontawesome/brands/medium
       link: https://medium.com/@datamaxiplus
 
-copyright: Copyright © 2024 BISONAI PTE. LTD.
+copyright: Copyright © 2024 DataMaxi+