kand/mkdocs.yml at main · kand-ta/kand · 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
# Project information
site_name: Kand - Blazingly Fast Technical Analysis Library
site_url: https://kand-ta.github.io/kand/
site_author: CtrlX
site_description: >-
  kand - Pure Rust reimplementation of TA-Lib for fast financial analysis.

# Repository
repo_url: https://github.com/kand-ta/kand
repo_name: kand-ta/kand

# Copyright
copyright: >
  Copyright &copy; 2024 - 2025 CtrlX –
  <a href="#__consent">Change cookie settings</a>

# Configuration
theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  language: en
  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)"
      primary: orange
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - content.tabs.link
    - navigation.sections
    - navigation.expand
    - navigation.path
    - content.code.copy
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
    - announce.dismiss
    - navigation.footer
    - navigation.indexes
    - content.code.select
    - content.code.annotate

# Additional configuration
extra:
  consent:
    title: Cookie Usage Statement
    description: >-
      We use cookies to record your behavior and preferences across multiple visits, as well as to evaluate the effectiveness of our documentation and whether users can find the information they need.
      With your consent, you will help us optimize our documentation content.
    consent:
    actions:
      - accept
      - reject
      - manage

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rust-ta
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/GitCtrlX

  generator: false

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
            python:
              options:
                show_root_heading: true
                show_source: false
                docstring_style: google
                show_if_no_docstring: false
                merge_init_into_class: true
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
          remove_comments: true
      cache_safe: true

markdown_extensions:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables

# Page tree
nav:
  - Home: "index.md"
  - Install:
      - Quick Start: "install.md"
      - Advanced Setup: "advance.md"
  - API: "api.md"
  - Changelog: "changelog.md"
  - Performance: "performance.md"
  - About: "about.md"