obsidian-plugin/tekknoman_obsidian-prio-plugin
1
0
Fork 0
mirror of https://github.com/tekknoman/obsidian-prio-plugin.git synced 2026-07-22 07:30:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(usage): changing usage documentatoin

Browse source
This commit is contained in:
EloiMusk 2023-03-16 08:07:56 +01:00
parent 02fdcc0ba8
commit 8e8f100028
No known key found for this signature in database
GPG key ID: A59863E13934DD4F
1 changed files with 11 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -18,21 +18,17 @@ You can install the Prioritize plugin via the Community Plugin Browser in Obsidi
## Usage ## Usage
1. After installing and configuring the plugin, you can mark any note or task with a priority level. After installing and configuring the plugin, you can prioritize notes or tasks by selecting the text you want to prioritize and choosing from different priority levels. You can configure the number of levels and assign a name for each level of priority in the plugin settings. Once you have set your preferences, you can easily switch between different presets or create your own.
2. To mark something with medium priority, select the text you want to prioritize and press `ctrl+shift+alt+p`.
3. The text will be marked with a tag that corresponds to the priority level at the end of the line. Here is a list of all the available actions:
4. You can customize the number of priority levels and their names via the plugin settings.
5. You can switch between different presets and create your own presets. - `Set Priority`: Mark selected text with a priority level.
6. To remove priority, press `ctrl+shift+alt+d`. - `Remove Priority`: Remove a previously set priority level.
7. To increase priority, press `ctrl+shift+alt+ArrowUp`. - `Increase Priority`: Increase the priority level of selected text.
8. To decrease priority, press `ctrl+shift+alt+ArrowDown`. - `Decrease Priority`: Decrease the priority level of selected text.
To use these actions, you can either access them from the Command Palette or create a hotkey for each action.
| HotKeys | Action |
|--------------------|-------------------|
| `ctrl+shift+alt+p` | Set priority |
| `ctrl+shift+alt+d` | Remove priority |
| `Ctrl+Shift+Alt+↑` | Increase priority |
| `Ctrl+Shift+Alt+↓` | Decrease priority |
### Configuration ### Configuration
In the settings tab, you can configure the Prioritize plugin to your liking. This includes setting the number of levels of priority and assigning a name for each level. To save your configuration, you need to click the `Save` button. In the settings tab, you can configure the Prioritize plugin to your liking. This includes setting the number of levels of priority and assigning a name for each level. To save your configuration, you need to click the `Save` button.
@ -51,9 +47,8 @@ If you'd like to contribute to the Prioritize plugin, please fork the GitHub rep
The Prioritize plugin is released under the GNU License. The Prioritize plugin is released under the GNU License.
## Improve code quality with eslint (optional) ## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. - [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal: - To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint` - `npm install -g eslint`