Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wenlzhang/obsidian-task-marker
An [Obsidian](https://obsidian.md/) plugin to change task status and append text with hotkeys and right-click context menu.
https://github.com/wenlzhang/obsidian-task-marker
Last synced: 2 months ago
JSON representation
An [Obsidian](https://obsidian.md/) plugin to change task status and append text with hotkeys and right-click context menu.
- Host: GitHub
- URL: https://github.com/wenlzhang/obsidian-task-marker
- Owner: wenlzhang
- License: agpl-3.0
- Created: 2022-12-27T14:20:04.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-05T18:30:47.000Z (11 months ago)
- Last Synced: 2024-08-02T17:29:55.478Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 9.58 MB
- Stars: 37
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-obsidian-zh - wenlzhang/obsidian-task-marker
README
# Task Marker
[](https://github.com/wenlzhang/obsidian-task-marker/releases) 
An [Obsidian](https://obsidian.md/) plugin to change task status and append text with hotkeys and right-click context menu.
## Features
- Create tasks
- Mark list items with `[ ]`
- Optionally append text such as `📝 2023-01-01`
- Complete and cancel tasks
- Mark tasks with `[x]` and `[-]`
- Optionally append text such as `✅ 2023-01-01`
- Mark tasks
- Mark tasks with statuses such as `[>]` and `[/]`
- Mark individual task statuses with hotkeys
- Optionally append text such as `❎ 2023-01-01`
- Cycle tasks
- Cycle among configured statuses such as `[x]`, `[-]`, `[>]` and `[/]`
- Reversely cycle among configured statuses
- Include list item as the first cycled status 📝 2023-11-06
- A toggle is added for selecting whether to include the list item as the first cycled status or not.
- Cycle tasks among additional lists of statuses 📝 2023-11-04
- E.g., list 1 `x->/` for task execution status
- E.g., list 2 `?!biI` for task importance
- E.g., list 3 `pcud` for task pro/con/up/down
- Append text
- Command to append text such as `📝 2023-01-01` to any line
- Command to append text such as `✅ 2023-01-01` to any line
- Command to append text such as `❎ 2023-01-01` to any line
- Append text automatically 📝 2023-03-04
- Automatically append text according to task/line status
### Miscellaneous
- Support operating on items that start with `-+*` 📝 2023-07-24
- Retain cursor location when operating on tasks 📝 2023-11-07
- The cursor location is set with respect to text, excluding item/task prefix.
- The behaviour is the same as the default Obsidian command `Cycle bullet/checkbox`.
## Usage
### How to use
See [Usage](docs/Usage.md) for details.
### How to configure
Task Marker uses [moment.js](https://momentjs.com/docs/#/displaying/format/) to format the date and time to be appended. In addition, **square brackets** are needed to surround the content that is not part of the format string.
- For example, if `[completion::2023-01-01]` is the desired text to be appended, then `[[completion::]YYYY-MM-DD[]]` needs to be configured in settings.
See [Setting](docs/Setting.md) for more detailed settings.
### How to install
Install the plugin from the Obsidian Community Plugins store:
1. Go to `Settings > Community plugins` and disable "Restricted mode"
2. Click "Browse" to search for plugins and type "task marker"
3. Select **Task Marker** and click "Install"
4. Enable Task Marker and configure it as desired
### Resources
See [Resource](docs/Resource.md) for details.
## Development process
You can see how this plugin is developed starting from scratch as follows:
- [Project actions - Develop an Obsidian plugin for changing task status - 202212262317 - PTKM Experiment](https://exp.ptkm.net/220-Development/Project+action/Project+actions+-+Develop+an+Obsidian+plugin+for+changing+task+status+-+202212262317)
## Credits
- [Obsidian: Task Collector](https://github.com/ebullient/obsidian-task-collector)
- This plugin serves as a starting template.
## Support me
