Update README.md

This commit is contained in:
frankthwang 2025-07-04 14:19:34 +08:00
parent 2444e8339d
commit 36e30da6a5
2 changed files with 24 additions and 5 deletions

View file

@ -15,6 +15,8 @@ A text block timing tool designed for Obsidian, allowing you to add timing funct
## Usage Method
[Strongly Recommended] Write your task first before adding a timer!
### (1) Command Palette + Shortcuts (Recommended ⭐️)
1. Assign a shortcut for the command "Text Block Timer: Toggle timer" for quick access
@ -33,6 +35,13 @@ A text block timing tool designed for Obsidian, allowing you to add timing funct
- It is recommended to keep the file (containing a running tiemr) open; otherwise, the real-time second updates of the timer may fail.
- However, the file will record the timer state, which can be manually resumed.
## Changelog:
- V1.0.1
1. A space is added before the time tag to better distinguish it from your content.
2. Fixed the issue where adding a timer disrupted the structure of checkboxes in Markdown.
- V1.0.0
1. Plugin release
## Development Information
- Developer: frankthwang

View file

@ -2,11 +2,11 @@
# 文本块计时器插件
一个为Obsidian设计的文本块计时工具可以在笔记中为任意文本行添加计时功能。
一个为Obsidian设计的文本块计时工具可以在笔记中为任意文本行添加**正计时**功能。
## 功能特性
<img src="https://github.com/wth461694678/text-block-timer/blob/main/demo.gif" width="50%" alt="">
<img src="https://github.com/wth461694678/text-block-timer/blob/main/demo.gif" width="50%" alt="">
- 为任意文本行添加计时器,支持同时执行多个计时器(正计时)
- ▶️/⏸️ 支持开始、暂停、继续计时,支持一个任务的多段计时累计
@ -15,23 +15,33 @@
## 使用方法
【强烈推荐】先撰写文本再添加Timer为你的任务即计时
### (一)命令行+快捷键(推荐⭐️)
1. 为命令 "Text Block Timer: Toggle timer" 配置快捷键,方便快速使用
2. 当光标在某个文本块时按下快捷键即可实现timer的开始、暂停、继续操作
<img src="https://github.com/wth461694678/text-block-timer/blob/main/command_shortcut.gif" width="50%" alt="">
3. 计时器会以 `【⏳00:00:00 】`格式显示在文本块的行首
`<img src="https://github.com/wth461694678/text-block-timer/blob/main/command_shortcut.gif" width="50%" alt="">`
### (二)鼠标操作
1. 在文本行上右键点击
2. 选择"开始计时"、"暂停计时"或"继续计时"
3. 计时器会以 `【⏳00:00:00 】`格式显示在文本块的行首
<img src="https://github.com/wth461694678/text-block-timer/blob/main/right_click.gif" width="50%" alt="">
`<img src="https://github.com/wth461694678/text-block-timer/blob/main/right_click.gif" width="50%" alt="">`
## 注意事项
- 建议保持文本块所在文件打开,否则会导致计时器的实时跳秒失效。但文件会保留计时器状态,下次打开文件时可以手动恢复计时。
## 版本日志:
- V1.0.1
1. 优化展示效果,在时间标签前添加了一个空格。
2. 解决了在任务清单中添加计时器,导致任务勾选框失效的问题。
- V1.0.0
1. 插件发布
## 开发信息
- 开发者: frankthwang