codex-admin/ObsidianTweaks
1
0
Fork 0
mirror of https://github.com/elisspace/ObsidianTweaks.git synced 2026-08-29 15:44:02 +00:00
Code Issues Releases Wiki Activity

update readme to make hotkey enabling more clear

Browse Source 
Moved the philosophy up to the top so it's extra clear the hotkeys or off by default, and added a bit more language to explain how to enable key bindings.
This commit is contained in:
Eli
2021-10-19 10:18:43 +07:00
committed by GitHub
parent 5f3f831420
commit e6f32d5f87
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -16,12 +16,18 @@ Until then manual installation is required:
5. Reload plugins (easiest way is just restarting Obsidian)
6. Activate the plugin as normal.
## Philosophy
- **By default no features are enabled**. You can enable the features you want.
- Thus all features can also be disabled.
- All code is released into public domain without any requirement for attribution using the [Unlicense](https://unlicense.org/).
## Features
Below is a list of the current functionality that has been implemented.
Below is a list of the current functionality available for you to enable.
Note that hotkeys cannot be 'disabled', but they can be set to <kbd>Blank</kbd>.
They are all set to <kbd>Blank</kbd> by default.
They are all set to <kbd>Blank</kbd> by default. Go to `Settings > Hotkeys` to set the shortcut to match suggestions below, or use your own binding!
### Commands
| Recommended hotkey | Action |
@@ -68,11 +74,6 @@ Math toggles are also included.
![Default formatting](images/DefaultFormatting.gif)
![Better formatting](images/BetterFormatting.gif)
## Philosophy
- By default no features are enabled. You can enable the features you want.
- Thus all features can also be disabled.
- All code is released into public domain without any requirement for attribution using the [Unlicense](https://unlicense.org/).
## Why Unlicense?