No description
Find a file
2023-03-16 07:48:44 +01:00
utils fix(setting-tab): cleanup 2023-03-10 09:08:28 +01:00
.editorconfig Initial commit 2023-03-08 08:13:43 +01:00
.eslintignore Initial commit 2023-03-08 08:13:43 +01:00
.eslintrc Initial commit 2023-03-08 08:13:43 +01:00
.gitignore feat(plugin): implementing base functionality 2023-03-08 13:08:45 +01:00
.npmrc Initial commit 2023-03-08 08:13:43 +01:00
esbuild.config.mjs Initial commit 2023-03-08 08:13:43 +01:00
LICENSE Create LICENSE 2023-03-10 08:59:22 +01:00
main.ts fix(hotkeys): removing default hotkeys 2023-03-16 07:48:44 +01:00
manifest.json fix(hotkeys): removing default hotkeys 2023-03-16 07:48:44 +01:00
package.json fix(hotkeys): removing default hotkeys 2023-03-16 07:48:44 +01:00
README.md feat(readme): adding README file 2023-03-10 08:29:08 +01:00
styles.css fix(setting-tab): cleanup 2023-03-09 14:32:09 +01:00
tsconfig.json Initial commit 2023-03-08 08:13:43 +01:00
version-bump.mjs Initial commit 2023-03-08 08:13:43 +01:00
versions.json fix(hotkeys): removing default hotkeys 2023-03-16 07:48:44 +01:00

Prioritize Plugin

The Prioritize plugin for Obsidian allows you to easily mark notes or tasks with a priority level. You can configure the number of priority levels and their names, and switch between different presets or create your own presets.

Installation

You can install the Prioritize plugin via the Community Plugin Browser in Obsidian, or you can build it directly from the GitHub repository: https://github.com/EloiMusk/obsidian-prio-plugin

From source

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run dev to start compilation in watch mode.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.

Usage

  1. After installing and configuring the plugin, you can mark any note or task with a priority level.
  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.
  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.
  6. To remove priority, press ctrl+shift+alt+d.
  7. To increase priority, press ctrl+shift+alt+ArrowUp.
  8. To decrease priority, press ctrl+shift+alt+ArrowDown.
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

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.

There are also presets available in the plugin. To create a new preset, configure the plugin as you like and then click the Add Preset button. This will open a window where you can enter a unique name for the preset. Once you have named the preset, it will be saved as a new preset. Remember to save the settings afterward to keep your new preset.

To apply a preset, click the Apply button on the preset you want to use. This will overwrite the current settings with the preset. If you want to overwrite a preset, you can do so by pressing the Overwrite button. This will overwrite the preset with the current configuration.

If you want to delete a preset, simply press the Delete button.

Contributing

If you'd like to contribute to the Prioritize plugin, please fork the GitHub repository and submit a pull request.

License

The Prioritize plugin is released under the GNU License.

Improve code quality with eslint (optional)

  • ESLint 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:
    • npm install -g eslint
  • To use eslint to analyze this project use this command:
    • eslint main.ts
    • eslint will then create a report with suggestions for code improvement by file and line number.
  • If your source code is in a folder, such as src, you can use eslint with this command to analyze all files in that folder:
    • eslint .\src\

API Documentation

See https://github.com/obsidianmd/obsidian-api