Skip to content

Commit

Permalink
README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
kzhovn committed Jun 7, 2022
1 parent c2d3c82 commit f3099bb
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# File Explorer Keyboard Navigation

Adds commands to open the next/previous file in the file explorer.
Adds commands to open the next/previous file in the file explorer. There are no default hotkey bindings; go to `Settings` -> `Hotkeys` to set your own. I use `Ctrl` + ``/``.

This plugin is currently a simple proof-of-concept with only limited testing. It may navigate files out of visual order, especially when dealing with non-standard characters or non-latin text. Please file an issue if you notice any errors.

## Limitations
This plugin is currently a simple proof-of-concept with only limited testing. It navigates files within the parent folder of the currently opened note, **in alphabetical order** by note name. If you have any other sort order enabled, this plugin will still move alphabetically and not according to the visual sort order.
The commands navigate files within the parent folder of the currently opened note, **in alphabetical or reverse alphabetical order** by note name. If your files are displayed in "Modified time" or "Created time" order, the plugin will iterate through the files as if they were in alphabetical order.

The plugin does not recognize files immediately on creation. If it is skipping new files, refresh or restart Obsidian.
The plugin may not correctly recognize files immediately on creation, and Obsidian ocassionally orders files strangely immediately after a rename. If it is skipping new files, refresh or restart Obsidian.

There are no default hotkey bindings; go to `Settings` -> `Hotkeys` to set your own. I use `Ctrl` + ``/``.
Some files with trailing punctuation may be out of order.

## Installation

Expand Down

0 comments on commit f3099bb

Please sign in to comment.