Skip to content

Commit

Permalink
Added features description in README
Browse files Browse the repository at this point in the history
  • Loading branch information
vslinko committed May 23, 2021
1 parent 74bad50 commit 20fcc75
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,29 @@ You can activate this plugin within Obsidian by doing the following:

Download `main.js`, `manifest.json`, `styles.css` from the [latest release](https://github.com/vslinko/obsidian-zoom/releases/latest) and put them into `<vault>/.obsidian/plugins/obsidian-zoom` folder.

## Features

### Zoom in to a specific list or heading

Hide everything except the list/heading and its content.

| Command | Default hotkey (Windows/Linux) | Default hotkey (MacOS) |
| ---------------------------- | :-----------------------------------------: | :--------------------------------------------: |
| Zoom in | <kbd>Ctrl</kbd><kbd>.</kbd> | <kbd>Command</kbd><kbd>.</kbd> |
| Zoom out the entire document | <kbd>Ctrl</kbd><kbd>Shift</kbd><kbd>.</kbd> | <kbd>Command</kbd><kbd>Shift</kbd><kbd>.</kbd> |

| Setting | Default value |
| -------------------------------------- | :-----------: |
| Zooming in when clicking on the bullet | `true` |

### Debug mode

Open DevTools (Command+Option+I or Control+Shift+I) to copy the debug logs.

| Setting | Default value |
| ---------- | :-----------: |
| Debug mode | `false` |

## Pricing

This plugin is free for everyone, however, if you would like to thank me
Expand Down
2 changes: 1 addition & 1 deletion src/features/ZoomFeature.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export class ZoomFeature implements IFeature {
async load() {
this.plugin.addCommand({
id: "zoom-in",
name: "Zoom in to the current list item",
name: "Zoom in",
callback: this.obsidianService.createCommandCallback(
this.zoomService.zoomIn.bind(this.zoomService)
),
Expand Down

0 comments on commit 20fcc75

Please sign in to comment.