You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42-8
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,13 @@
1
-
# Blocknav
1
+
# Block Navigation
2
2
3
3
## Synopsis
4
4
5
-
Super simple plugin to facilitate block navigation in [Logseq](https://www.logseq.com/).
5
+
Simple plugin to facilitate top-level block navigation in [Logseq](https://www.logseq.com/).
6
6
7
7
## Installation
8
8
9
-
Not currently in the marketplace.
10
-
11
-
To load, must turn on developer mode in settings and load as an "unpacked plugin" from the Logseq plugins page (`t p`).
9
+
1.**(Recommended)** Install from the plugin marketplace.
10
+
2. Turn on developer mode in settings and load this repo as an "unpacked plugin" from the Logseq plugins page (`t p`).
12
11
13
12
## Usage (default keybinds)
14
13
@@ -28,11 +27,11 @@ Keybind|Action
28
27
29
28
## Settings
30
29
31
-
As of `v0.0.2` the plugin will allow you to disable the default key bindings and optionally provide your own.
30
+
The plugin settings page allows disabling the default key bind set and optionally providing your own.
32
31
33
-
Changing custom keybinds requires editing the plugin JSON settings.
32
+
Changing custom keybinds requires editing the plugin JSON settings manually. It currently seems necessary to restart Logseq for the changes to be applied. Also see [Possible Issues](#possible-issues).
34
33
35
-
### Default settings JSON
34
+
### Default Settings JSON
36
35
37
36
```json
38
37
{ "default-shortcuts": true,
@@ -65,3 +64,38 @@ Key|Type|Description
65
64
`disabled`|boolean|Disables this definition. Defaults to `false`. **(optional)**
66
65
`new`|boolean|Prepend a block if the index is positive, otherwise append. Defaults to `false`. **(optional)**
67
66
`onlySelect`|boolean|**Experimental**: Only select the block, do not edit it. Defaults to `false`. **(optional)**
67
+
68
+
69
+
### Keybind Ideas
70
+
71
+
#### Direct Block Indexing
72
+
73
+
It's possible to dispense with the `b` prefix for keybinds and just use `1` to edit the first block, `- 1` to edit the last, etc. Here is an example using that approach with `^`, `$` to prepend/append blocks (modeled after regex anchors.)
Invalid data in the settings JSON file is not currently handled very gracefully. If you've edited the that file and are experiencing problems, it's very likely due to something like a trailing comma in one of the entries causing a JSON syntax error. *Solution: Correct the error and restart Logseq.*
0 commit comments