FinMind-Doc/mkdocs.yml at master · FinMind/FinMind-Doc · 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
# ============================================================
#  Site
# ============================================================
site_name: FinMind
site_url: https://finmind.github.io/
site_author: 'Sam'
copyright: 'Copyright'

# ============================================================
#  Repository
# ============================================================
repo_name: FinMind/FinMind
repo_url: https://github.com/FinMind/FinMind

# ============================================================
#  Theme
# ============================================================
theme:
    name: material
    language: 'zh-TW'
    font:
        text: Noto Sans TC   # 繁中友善（取代預設 Roboto）
        code: JetBrains Mono
    features:
        - navigation.tracking
        - navigation.top
        - navigation.footer
        - toc.follow
        - content.code.copy
        - content.code.annotate
        - content.tabs.link
        - search.highlight
        - search.suggest
        - search.share
    icon:
        repo: fontawesome/brands/github

# ============================================================
#  Extra（分析 + 社群）
# ============================================================
extra:
    analytics:
        provider: google
        property: G-N2YPL1PVLE
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/FinMind/FinMind
        - icon: fontawesome/solid/globe
          link: https://finmindtrade.com/

# ============================================================
#  Navigation
# ============================================================
nav:
    - 總覽: 'index.md'
    - 快速開始: "quickstart.md"
    - 登入:
        - 登入說明: "login.md"
        - 更新 Token: "update_token.md"
    - API 使用次數: "api_usage_count.md"
    - 資料集:
        - 台灣市場:
            - 總覽: "tutor/TaiwanMarket/DataList.md"
            - 技術面: "tutor/TaiwanMarket/Technical.md"
            - 籌碼面: "tutor/TaiwanMarket/Chip.md"
            - 基本面: "tutor/TaiwanMarket/Fundamental.md"
            - 衍生性金融商品: "tutor/TaiwanMarket/Derivative.md"
            - 即時資料:
                - 即時資料: "tutor/TaiwanMarket/RealTime.md"
                - 指數代號對照: "tutor/TaiwanMarket/IndexCodes.md"
            - 可轉債: "tutor/TaiwanMarket/ConvertibleBond.md"
            - 其他: "tutor/TaiwanMarket/Others.md"
        - 美國市場:
            - 總覽: "tutor/UnitedStatesMarket/DataList.md"
            - 技術面: "tutor/UnitedStatesMarket/Technical.md"
        - 英國市場:
            - 總覽: "tutor/UnitedKingdomMarket/DataList.md"
            - 技術面: "tutor/UnitedKingdomMarket/Technical.md"
        - 歐洲市場:
            - 總覽: "tutor/EuropeMarket/DataList.md"
            - 技術面: "tutor/EuropeMarket/Technical.md"
        - 日本市場:
            - 總覽: "tutor/JapanMarket/DataList.md"
            - 技術面: "tutor/JapanMarket/Technical.md"
        - 匯率: "tutor/ExchangeRate.md"
        - 央行利率: "tutor/InterestRate.md"
        - 原物料市場: "tutor/Materials.md"
        - 美國國債: "tutor/GovernmentBondsYield.md"
        - 其他: "tutor/Others.md"
    - AI Agent / MCP / llms.txt:
        - llms.txt: "tutor/ai/Llms.md"
        - Agent Skill: "tutor/ai/AgentSkill.md"
        - MCP Server: "tutor/ai/Mcp.md"
    - 量化工具:
        - 回測: "tutor/analysis/Backtesting.md"
        - 回測(引用外部 data): "tutor/analysis/BacktestingOtherData.md"
        - K 線: "tutor/analysis/Kline.md"
        - 客製化看盤儀表板: "tutor/analysis/CustomerDashboardWebServer.md"
        - 即時股市資訊 X 板塊圖: "tutor/analysis/SnapshotTreemap.md"
    - 更新公告: "WhatIsNew.md"
    - 版本紀錄: "release.md"
    - 服務與政策:
        - 服務狀態與可用率: "ServiceStatus.md"
        - 壓力測試: "StressTest.md"
        - IP 封鎖政策: "BanIPPolicy.md"
    - 關於:
        - 聯絡我們: "Contact.md"
        - 使用條款與隱私權政策: "PrivacyPolicy.md"
        - 免責聲明與資料授權: "Disclaimer.md"
        - 贊助我們: "Donate.md"
        - 官方網站: https://finmindtrade.com/

# ============================================================
#  Markdown extensions
# ============================================================
markdown_extensions:
    - toc:
        permalink: true
    - markdown_include.include:
        base_path: docs
    - markdown.extensions.meta:
    - admonition
    - pymdownx.details   # 可摺疊的 admonition（??? 收合區塊）
    - attr_list          # 連結/元素屬性（例如外連開新分頁）
    - md_in_html
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.inlinehilite:
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.superfences:
        custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format

# ============================================================
#  Plugins（搜尋 + i18n 雙語）
# ============================================================
plugins:
    - search:
        lang:
            - en
            - ja
        separator: '[\s\-\.]+'
    - i18n:
        docs_structure: suffix
        fallback_to_default: true
        reconfigure_material: true
        reconfigure_search: true
        languages:
            - locale: zh
              default: true
              name: 中文
              build: true
              site_name: FinMind
              theme:
                language: zh-TW
            - locale: en
              name: English
              build: true
              site_name: FinMind
              theme:
                language: en
              nav_translations:
                總覽: Overview
                快速開始: Quick Start
                登入: Login
                登入說明: Login Guide
                更新 Token: Update Token
                API 使用次數: API Usage Count
                資料集: Datasets
                台灣市場: Taiwan Market
                技術面: Technical
                籌碼面: Chip (Institutional)
                基本面: Fundamental
                衍生性金融商品: Derivative
                即時資料: Real-Time
                指數代號對照: Index Codes
                可轉債: Convertible Bond
                其他: Others
                美國市場: US Market
                英國市場: UK Market
                歐洲市場: Europe Market
                日本市場: Japan Market
                匯率: Exchange Rate
                央行利率: Central Bank Interest Rate
                原物料市場: Commodities
                美國國債: US Government Bonds Yield
                量化工具: Analysis Tools
                回測: Backtesting
                回測(引用外部 data): Backtesting (External Data)
                K 線: K-Line
                客製化看盤儀表板: Custom Dashboard
                即時股市資訊 X 板塊圖: Snapshot Treemap
                更新公告: What's New
                版本紀錄: Release Note
                服務與政策: Service & Policy
                關於: About
                服務狀態與可用率: Service Status & Uptime
                壓力測試: Stress Test
                IP 封鎖政策: IP Ban Policy
                聯絡我們: Contact Us
                使用條款與隱私權政策: Terms of Use & Privacy Policy
                免責聲明與資料授權: Disclaimer & Data Licensing
                贊助我們: Donate
                官方網站: Official Website