Archives/zk-nvim
2
0
Fork 0
mirror of https://github.com/mickael-menu/zk-nvim synced 2024-11-17 15:25:43 +00:00
Code Issues Projects Releases Wiki Activity

Fix typos in README (#15)

Browse Source
This commit is contained in:
Karim Abou Zeid 2022-01-04 09:44:14 +01:00 committed by GitHub
parent b0ce17b020
commit 17d2880421
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -160,13 +160,13 @@ In addition, `options.notebook_path` can be used to explicitly specify a noteboo
---
**Via Lua**
You can access the underlying Lua function of a commands, with `require("zk.commands").get`.
You can access the underlying Lua function of a command, with `require("zk.commands").get`.
*Examples:*
```lua
require("zk.commands").get("ZkNew")({ dir = "daily" })
require("zk.commands").get("ZkNotes")({ createdAfter = "3 days ago", tags = { "work" } })
require("zk.commands").get("ZkNewFromTitleSelection")() -- this will use your last visual mode selection
require("zk.commands").get("ZkNewFromTitleSelection")()
```
## Custom Commands
@ -194,7 +194,7 @@ commands.add("ZkOrphans", function(options)
end)
```
This adds the `:ZkOrphans [{options}]` vim user command, which accepts an `options` Lua table as an argument.
We can execute it like this `:ZkOrphans { tags = "work" }` for example.
We can execute it like this `:ZkOrphans { tags = { "work" } }` for example.
> Note: The `zk.edit` function is from the [high-level API](#high-level-api), which also contains other functions that might be useful for your custom commands.