crowdcent-challenge/mkdocs.yml at main · crowdcent/crowdcent-challenge · 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
site_name: CrowdCent Challenge Docs
site_description: Official Documentation for the CrowdCent Challenge. Including Python API Client and CLI for the CrowdCent Challenge API.
repo_url: https://github.com/crowdcent/crowdcent-challenge
repo_name: crowdcent-challenge
copyright: Made by CrowdCent

nav:
  - Challenge Docs:
      - Overview: index.md
      - Getting Started: getting-started.md
      - Scoring : scoring.md
      - Points System: points-system.md
      - FAQ: faq.md
      - Challenges:
          - Hyperliquid Ranking: hyperliquid-ranking.md
          - Equity NLP &#128683;: equity-nlp.md
      - Python Client:
          - Install & Quick Start: install-quickstart.md
          - AI Agents (MCP): ai-agents-mcp.md
      - More:
          - About CrowdCent: about.md
          - Contributing: contributing.md
          - Disclaimer: disclaimer.md
  - Tutorials:
      - Getting Started:
          - Hyperliquid End-to-End: tutorials/hyperliquid-end-to-end.ipynb
      - Modeling:
          - XGBoost vs LSTM with CV: tutorials/advanced-cv-lstm.ipynb
          - Build a Custom Dataset: tutorials/advanced-custom-dataset-eodhd.ipynb
          - Advanced Multi-Data Multi-Slots: tutorials/advanced-multi-data-slots.ipynb
      - Workflow:
          - Track Your Performance: tutorials/track-your-performance.ipynb
          - Submission Automation: tutorials/submission-automation.md
  - API Reference:
      - Python: api-reference/python.md
      - CLI: api-reference/cli.md
      - OpenAPI: https://crowdcent.com/api/swagger-ui/
  - Challenge App: https://crowdcent.com/challenge

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/images/cc_logo.png
  favicon: assets/images/cc_logo.png
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.tracking
    - navigation.expand
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.sections
    - navigation.footer
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  font:
    text: Poppins

extra_css:
  - overrides/assets/stylesheets/extra.css
  - https://unpkg.com/katex@0/dist/katex.min.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.arithmatex:
      generic: true
  - mkdocs-click
  - attr_list
  - md_in_html

plugins:
  - search
  - git-revision-date-localized
  - git-authors:
     show_email_address: false
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_source: true
  - mkdocs-jupyter:
        include_source: True
  - open-in-new-tab

extra_javascript:
    - "overrides/assets/js/runllm-widget.js"
    - "overrides/assets/js/katex.js"
    - https://unpkg.com/katex@0/dist/katex.min.js
    - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/v6ZSGuTbQS
      name: crowdcent on discord
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/CrowdCent
      name: crowdcent on X
    - icon: fontawesome/brands/github
      link: https://github.com/CrowdCent
      name: crowdcent on github
  generator: false