Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chef5 committed Oct 15, 2024
1 parent a659139 commit 02ca8b3
Showing 1 changed file with 26 additions and 26 deletions.
52 changes: 26 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ VScode 插件 | A 股 | 港股 | 期货 | 实时股票数据 | 状态栏实时

`Stock Bar` 会在开盘期间自动刷新股票数据,并在 VScode 底部状态栏显示股票基本数据,让你在使用 VScode 期间能随时关注到你的股票。

为了隐秘性,`Stock Bar` 默认只会显示股价、百分点这样的纯数字,当你将鼠标移上去就可以查看详情。当然为了区分,也可以自定义显示股票的名称
`Stock Bar` 默认只会显示股价、百分点这样的纯数字,当你将鼠标移上去就可以查看详情。当然为了区分,也可以自定义显示股票的名称

![image](https://raw.githubusercontent.com/Chef5/stock-bar/main/stock-bar-plugin.png)

Expand All @@ -14,8 +14,8 @@ VScode 插件 | A 股 | 港股 | 期货 | 实时股票数据 | 状态栏实时

`Ctrl/Cmd + Shift + P` 打开命令输入面板:

- Show Stock Bar 显示Stock Bar
- Hide Stock Bar 关闭Stock Bar(后台不再发起更新数据请求)
- `Show Stock Bar` 显示 Stock Bar
- `Hide Stock Bar` 关闭 Stock Bar(后台不再发起更新数据请求)

## 插件配置

Expand Down Expand Up @@ -57,38 +57,38 @@ VScode 插件 | A 股 | 港股 | 期货 | 实时股票数据 | 状态栏实时

股票配置可以股票代码字符串,也可以进行一下配置:

- `**code**: string`: 股票代码,需要添加股市前缀,前缀参考文档下方:前缀说明
- `**alias**: string`: 别名,默认为空
- `**hold_price**: number`: 持仓价格,非必填,默认为0
- `**hold_number**: number`: 持仓数量,非必填,默认为0
- **code**: `string`股票代码,需要添加股市前缀,前缀参考文档下方:前缀说明
- **alias**: `string`别名,默认为空
- **hold_price**: `number`持仓价格,非必填,默认为0
- **hold_number**: `number`持仓数量,非必填,默认为0

股票代码字符串时,如:`["sz000001"]` 等价于 `[{"code": "sz000001", "alias": "", "hold_price": 0, "hold_number": 0}]`

## 期货配置说明

- `**code**: string`: 期货代码, 如:`cu2409``sa2409`
- `**alias**: string`: 期货别名
- `**hold_price**: number`: 持仓价格,即多空单的价格
- `**hold_number**: number`: 持仓,正数代表持有多单,负数代表持有空单
- **code**: `string`期货代码, 如:`cu2409``sa2409`
- **alias**: `string`期货别名
- **hold_price**: `number`持仓价格,即多空单的价格
- **hold_number**: `number`持仓,正数代表持有多单,负数代表持有空单


## 前缀说明

- sh:沪市,不加前缀的情况下,6 开头的代码默认加上 sh(上证指数:sh000001)
- sz:深市,不加前缀的情况下,除 6 开头的代码外,默认加上 sz
- hk:港股,如:阿里巴巴港股 hk09988
- US\_:美股,如:苹果股票 US_AAPL
- hkHSC:工商指数(港股指数)
- hkHSCEI:恒生中国企业指数(港股指数)
- hkHSI:恒生指数(港股指数)
- hkHSCCI:红筹指数(港股指数)
- hkHSF:恒生金融分类(港股指数)
- hkHSP:恒生地产分类(港股指数)
- hkHSU:恒生公用事业分类(港股指数)
- hkGEM:标普香港创业板指(港股指数)
- US_DOWJONES:道琼斯指数(美股指数)
- US_NASDAQ:纳斯达克(美股指数)
- US_SP500:标普 500(美股指数)
- **sh**:沪市,不加前缀的情况下,`6` 开头的代码默认加上 `sh`(上证指数:`sh000001`
- **sz**:深市,不加前缀的情况下,除 `6` 开头的代码外,默认加上 `sz`
- **hk**:港股,如:阿里巴巴港股 `hk09988`
- **US\_**:美股,如:苹果股票 `US_AAPL`
- **hkHSC**:工商指数(港股指数)
- **hkHSCEI**:恒生中国企业指数(港股指数)
- **hkHSI**:恒生指数(港股指数)
- **hkHSCCI**:红筹指数(港股指数)
- **hkHSF**:恒生金融分类(港股指数)
- **hkHSP**:恒生地产分类(港股指数)
- **hkHSU**:恒生公用事业分类(港股指数)
- **hkGEM**:标普香港创业板指(港股指数)
- **US_DOWJONES**:道琼斯指数(美股指数)
- **US_NASDAQ**:纳斯达克(美股指数)
- **US_SP500**:标普 500(美股指数)

## 更新日志

Expand Down

0 comments on commit 02ca8b3

Please sign in to comment.