Skip to content

Commit a3971f4

Browse files
authored
Merge pull request #128 from FinMind/docs/whatsnew-service-status
docs: WhatsNew 補登服務狀態頁(中英)+ mkdocs.yml 整理
2 parents 81b4dfe + b59b52f commit a3971f4

3 files changed

Lines changed: 68 additions & 21 deletions

File tree

docs/WhatIsNew.en.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
#### 2026-06-03
2+
* Added [Service Status & Uptime](https://finmind.github.io/en/ServiceStatus/): a public, real-time status page at [status.finmindtrade.com](https://status.finmindtrade.com), explaining how API uptime is calculated and the status tiers (Operational / Degraded Performance / Partial Outage / Major Outage), which serve as the basis for the enterprise-plan SLA.
3+
14
#### 2026-05-23
25
* Added [Taiwan Stock Index Codes](https://finmind.github.io/en/tutor/TaiwanMarket/IndexCodes/): [taiwan_stock_tick_snapshot](https://finmind.github.io/en/tutor/TaiwanMarket/RealTime/#taiwan_stock_tick_snapshot-sponsor) `data_id` also accepts 91 three-digit index codes in addition to 4-digit stock IDs (e.g. `001` = TAIEX, `101` = OTC weighted), grouped into broad market / sector / themed (Smart Beta) / leverage & inverse categories.
36

docs/WhatIsNew.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
#### 2026-06-03
2+
* 新增 [服務狀態與可用率 ServiceStatus](https://finmind.github.io/ServiceStatus/) 頁面:提供公開即時狀態頁 [status.finmindtrade.com](https://status.finmindtrade.com),說明 API 可用率 (uptime) 的計算方式與狀態分級(Operational / Degraded Performance / Partial Outage / Major Outage),作為企業方案 SLA 的衡量基準
3+
14
#### 2026-05-23
25
* 新增 [台股指數代號對照表 IndexCodes](https://finmind.github.io/tutor/TaiwanMarket/IndexCodes/)[台股即時資訊 taiwan_stock_tick_snapshot](https://finmind.github.io/tutor/TaiwanMarket/RealTime/#taiwan_stock_tick_snapshot-sponsor)`data_id` 除 4 碼個股代號外,亦支援 91 個 3 碼指數代號(例 `001` 加權指數、`101` 櫃買加權),完整對照分為大盤 / 產業 / 主題 Smart Beta / 槓桿反向 五組
36

mkdocs.yml

Lines changed: 62 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,56 @@
1+
# ============================================================
2+
# Site
3+
# ============================================================
14
site_name: FinMind
25
site_url: https://finmind.github.io/
36
site_author: 'Sam'
4-
57
copyright: 'Copyright'
68

9+
# ============================================================
10+
# Repository
11+
# ============================================================
12+
repo_name: FinMind/FinMind
13+
repo_url: https://github.com/FinMind/FinMind
14+
15+
# ============================================================
16+
# Theme
17+
# ============================================================
718
theme:
819
name: material
920
language: 'zh-TW'
21+
font:
22+
text: Noto Sans TC # 繁中友善(取代預設 Roboto)
23+
code: JetBrains Mono
1024
features:
25+
- navigation.tracking
26+
- navigation.top
27+
- navigation.footer
28+
- toc.follow
1129
- content.code.copy
30+
- content.code.annotate
1231
- content.tabs.link
13-
- navigation.top
1432
- search.highlight
33+
- search.suggest
34+
- search.share
35+
icon:
36+
repo: fontawesome/brands/github
1537

16-
repo_name: FinMind/FinMind
17-
repo_url: https://github.com/FinMind/FinMind
18-
38+
# ============================================================
39+
# Extra(分析 + 社群)
40+
# ============================================================
1941
extra:
20-
analytics:
21-
provider: google
22-
property: G-N2YPL1PVLE
42+
analytics:
43+
provider: google
44+
property: G-N2YPL1PVLE
45+
social:
46+
- icon: fontawesome/brands/github
47+
link: https://github.com/FinMind/FinMind
48+
- icon: fontawesome/solid/globe
49+
link: https://finmindtrade.com/
2350

51+
# ============================================================
52+
# Navigation
53+
# ============================================================
2454
nav:
2555
- 總覽: 'index.md'
2656
- 快速開始: "quickstart.md"
@@ -64,27 +94,31 @@ nav:
6494
- K 線: "tutor/analysis/Kline.md"
6595
- 客製化看盤儀表板: "tutor/analysis/CustomerDashboardWebServer.md"
6696
- 即時股市資訊 X 板塊圖: "tutor/analysis/SnapshotTreemap.md"
67-
- Versions:
68-
- What's New: "WhatIsNew.md"
69-
- Release Note: "release.md"
70-
- v4 (Latest): https://finmind.github.io/
71-
- v3: https://finmind.github.io/v3" target="_blank
72-
- 服務狀態與可用率: "ServiceStatus.md"
73-
- 壓力測試: "StressTest.md"
74-
- IP 封鎖政策: "BanIPPolicy.md"
75-
- 聯絡我們: "Contact.md"
76-
- 使用條款: "License.md"
77-
- 隱私權政策: "PrivacyPolicy.md"
78-
- 贊助我們: "Donate.md"
79-
- 官方網站: https://finmindtrade.com/" target="_blank
97+
- 更新公告: "WhatIsNew.md"
98+
- 版本紀錄: "release.md"
99+
- 服務與政策:
100+
- 服務狀態與可用率: "ServiceStatus.md"
101+
- 壓力測試: "StressTest.md"
102+
- IP 封鎖政策: "BanIPPolicy.md"
103+
- 關於:
104+
- 聯絡我們: "Contact.md"
105+
- 使用條款: "License.md"
106+
- 隱私權政策: "PrivacyPolicy.md"
107+
- 贊助我們: "Donate.md"
108+
- 官方網站: https://finmindtrade.com/
80109

110+
# ============================================================
111+
# Markdown extensions
112+
# ============================================================
81113
markdown_extensions:
82114
- toc:
83115
permalink: true
84116
- markdown_include.include:
85117
base_path: docs
86118
- markdown.extensions.meta:
87119
- admonition
120+
- attr_list # 連結/元素屬性(例如外連開新分頁)
121+
- md_in_html
88122
- pymdownx.highlight:
89123
anchor_linenums: true
90124
- pymdownx.inlinehilite:
@@ -99,6 +133,9 @@ markdown_extensions:
99133
class: mermaid
100134
format: !!python/name:pymdownx.superfences.fence_code_format
101135

136+
# ============================================================
137+
# Plugins(搜尋 + i18n 雙語)
138+
# ============================================================
102139
plugins:
103140
- search:
104141
lang:
@@ -155,6 +192,10 @@ plugins:
155192
K 線: K-Line
156193
客製化看盤儀表板: Custom Dashboard
157194
即時股市資訊 X 板塊圖: Snapshot Treemap
195+
更新公告: What's New
196+
版本紀錄: Release Note
197+
服務與政策: Service & Policy
198+
關於: About
158199
服務狀態與可用率: Service Status & Uptime
159200
壓力測試: Stress Test
160201
IP 封鎖政策: IP Ban Policy

0 commit comments

Comments
 (0)