Archives
/
zk-nvim
mirror of https://github.com/mickael-menu/zk-nvim
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Remove references to old repo (#158)

Browse Source 
as part of project handover, references to github.com/mickael-menu/zk-nvim are removed. 
Now pointing to ../zk-org/zk-nvim
pull/162/head
Michael McDonagh 4 months ago committed by GitHub
parent 142625638d
commit 094132da00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 67 additions and 67 deletions
Show Stats Download Patch File Download Diff File

2
.github/ISSUE_TEMPLATE/feature_request.yml vendored
Unescape Escape View File

@ -6,5 +6,5 @@ body:
attributes: attributes:
label: If you have an idea, open a discussion label: If you have an idea, open a discussion
options: options:
- label: I will [create a new discussion](https://github.com/mickael-menu/zk-nvim/discussions/new?category=ideas) instead of an issue. - label: I will [create a new discussion](https://github.com/zk-org/zk-nvim/discussions/new?category=ideas) instead of an issue.

2
.github/ISSUE_TEMPLATE/support.yml vendored
Unescape Escape View File

@ -10,4 +10,4 @@ body:
attributes: attributes:
label: If you need help, open a discussion label: If you need help, open a discussion
options: options:
- label: I will [create a new discussion](https://github.com/mickael-menu/zk-nvim/discussions/new?category=help) instead of an issue. - label: I will [create a new discussion](https://github.com/zk-org/zk-nvim/discussions/new?category=help) instead of an issue.

54
README.md
Unescape Escape View File

@ -1,5 +1,5 @@
# zk-nvim # zk-nvim
Neovim extension for the [`zk`](https://github.com/mickael-menu/zk) plain text note-taking assistant. Neovim extension for the [`zk`](https://github.com/zk-org/zk) plain text note-taking assistant.
## Requirements ## Requirements
@ -11,18 +11,18 @@ Neovim extension for the [`zk`](https://github.com/mickael-menu/zk) plain text n
Via [packer.nvim](https://github.com/wbthomason/packer.nvim) Via [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua ```lua
use("mickael-menu/zk-nvim") use("zk-org/zk-nvim")
``` ```
Via [vim-plug](https://github.com/junegunn/vim-plug) Via [vim-plug](https://github.com/junegunn/vim-plug)
```viml ```viml
Plug 'mickael-menu/zk-nvim' Plug 'zk-org/zk-nvim'
``` ```
Via [lazy.nvim](https://github.com/folke/lazy.nvim) Via [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua ```lua
{ {
"mickael-menu/zk-nvim", "zk-org/zk-nvim",
config = function() config = function()
require("zk").setup({ require("zk").setup({
-- See Setup section below -- See Setup section below
@ -83,9 +83,9 @@ However, this is always optional, and usually not necessary.
## Getting Started ## Getting Started
After you have installed the plugin and added the setup code to your config, you are good to go. If you are not familiar with `zk`, we recommend you to also read the [`zk` docs](https://github.com/mickael-menu/zk/tree/main/docs). After you have installed the plugin and added the setup code to your config, you are good to go. If you are not familiar with `zk`, we recommend you to also read the [`zk` docs](https://github.com/zk-org/zk/tree/main/docs).
When using the default config, the `zk` LSP client will automatically attach itself to buffers inside your notebook and provide capabilities like completion, hover and go-to-definition; see https://github.com/mickael-menu/zk/issues/22 for a full list of what is supported. When using the default config, the `zk` LSP client will automatically attach itself to buffers inside your notebook and provide capabilities like completion, hover and go-to-definition; see https://github.com/zk-org/zk/issues/22 for a full list of what is supported.
Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`, see what they can do, and learn as you go. Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`, see what they can do, and learn as you go.
@ -94,7 +94,7 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim ```vim
" Indexes the notebook " Indexes the notebook
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
:ZkIndex [{options}] :ZkIndex [{options}]
``` ```
@ -104,7 +104,7 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
" Use the `inline = true` option to insert the content of the created note at the caret position, instead of writing the note on the file system. " Use the `inline = true` option to insert the content of the created note at the caret position, instead of writing the note on the file system.
" "
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:ZkNew [{options}] :ZkNew [{options}]
``` ```
@ -114,7 +114,7 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
" Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system. " Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system.
" "
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:'<,'>ZkNewFromTitleSelection [{options}] :'<,'>ZkNewFromTitleSelection [{options}]
``` ```
@ -124,7 +124,7 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
" Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system. " Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system.
" "
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:'<,'>ZkNewFromContentSelection [{options}] :'<,'>ZkNewFromContentSelection [{options}]
``` ```
@ -138,28 +138,28 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim ```vim
" Opens a notes picker " Opens a notes picker
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkNotes [{options}] :ZkNotes [{options}]
``` ```
```vim ```vim
" Opens a notes picker for the backlinks of the current buffer " Opens a notes picker for the backlinks of the current buffer
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkBacklinks [{options}] :ZkBacklinks [{options}]
``` ```
```vim ```vim
" Opens a notes picker for the outbound links of the current buffer " Opens a notes picker for the outbound links of the current buffer
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkLinks [{options}] :ZkLinks [{options}]
``` ```
```vim ```vim
" Inserts a link at the cursor location or around the selected text. " Inserts a link at the cursor location or around the selected text.
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
" One additional option is `matchSelected` (boolean) which is only applicable to inserting a link around selected text. If `true`, the note picker will search for notes similar to the selected text. Otherwise, the note picker will load all notes to filter through. " One additional option is `matchSelected` (boolean) which is only applicable to inserting a link around selected text. If `true`, the note picker will search for notes similar to the selected text. Otherwise, the note picker will load all notes to filter through.
" e.g. :'<'>ZkInsertLinkAtSelection {matchSelected = true} " e.g. :'<'>ZkInsertLinkAtSelection {matchSelected = true}
:ZkInsertLink :ZkInsertLink
@ -169,19 +169,19 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim ```vim
" Opens a notes picker, filters for notes that match the text in the last visual selection " Opens a notes picker, filters for notes that match the text in the last visual selection
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:'<,'>ZkMatch [{options}] :'<,'>ZkMatch [{options}]
``` ```
```vim ```vim
" Opens a notes picker, filters for notes with the selected tags " Opens a notes picker, filters for notes with the selected tags
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
:ZkTags [{options}] :ZkTags [{options}]
``` ```
The `options` parameter can be any valid *Lua* expression that evaluates to a table. The `options` parameter can be any valid *Lua* expression that evaluates to a table.
For a list of available options, refer to the [`zk` docs](https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#custom-commands). For a list of available options, refer to the [`zk` docs](https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#custom-commands).
In addition, `options.notebook_path` can be used to explicitly specify a notebook by providing a path to any file or directory within the notebook; see [Notebook Directory Discovery](#notebook-directory-discovery). In addition, `options.notebook_path` can be used to explicitly specify a notebook by providing a path to any file or directory within the notebook; see [Notebook Directory Discovery](#notebook-directory-discovery).
*Examples:* *Examples:*
@ -269,7 +269,7 @@ require("zk").cd(options)
---Creates and edits a new note ---Creates and edits a new note
-- --
---@param options? table additional options ---@param options? table additional options
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
require("zk").new(options) require("zk").new(options)
``` ```
@ -277,7 +277,7 @@ require("zk").new(options)
---Indexes the notebook ---Indexes the notebook
-- --
---@param options? table additional options ---@param options? table additional options
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
require("zk").index(options) require("zk").index(options)
``` ```
@ -287,7 +287,7 @@ require("zk").index(options)
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
require("zk").pick_notes(options, picker_options, cb) require("zk").pick_notes(options, picker_options, cb)
``` ```
@ -298,7 +298,7 @@ require("zk").pick_notes(options, picker_options, cb)
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
---@see zk.ui.pick_tags ---@see zk.ui.pick_tags
require("zk").pick_tags(options, picker_options, cb) require("zk").pick_tags(options, picker_options, cb)
``` ```
@ -308,7 +308,7 @@ require("zk").pick_tags(options, picker_options, cb)
-- --
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
require("zk").edit(options, picker_options) require("zk").edit(options, picker_options)
``` ```
@ -322,7 +322,7 @@ You can use it to write your own specialized functions for interacting with `zk`
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
require("zk.api").index(path, options, function(err, stats) require("zk.api").index(path, options, function(err, stats)
-- do something with the stats -- do something with the stats
end) end)
@ -332,7 +332,7 @@ end)
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
require("zk.api").new(path, options, function(err, res) require("zk.api").new(path, options, function(err, res)
file_path = res.path file_path = res.path
-- do something with the new file path -- do something with the new file path
@ -343,7 +343,7 @@ end)
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options table additional options ---@param options table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
require("zk.api").list(path, options, function(err, notes) require("zk.api").list(path, options, function(err, notes)
-- do something with the notes -- do something with the notes
end) end)
@ -353,7 +353,7 @@ end)
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
require("zk.api").tag.list(path, options, function(err, tags) require("zk.api").tag.list(path, options, function(err, tags)
-- do something with the tags -- do something with the tags
end) end)
@ -480,7 +480,7 @@ require("nvim-treesitter.configs").setup({
``` ```
## nvim-lsp-installer ## nvim-lsp-installer
> Not recommended, instead install the [`zk`](https://github.com/mickael-menu/zk) CLI tool and make it available in your `$PATH`. > Not recommended, instead install the [`zk`](https://github.com/zk-org/zk) CLI tool and make it available in your `$PATH`.
If you insist to use nvim-lsp-installer for `zk`, the following code snippet should guide you on how to setup the `zk` server when installed via nvim-lsp-installer. If you insist to use nvim-lsp-installer for `zk`, the following code snippet should guide you on how to setup the `zk` server when installed via nvim-lsp-installer.

50
doc/zk.txt
Unescape Escape View File

@ -23,7 +23,7 @@ CONTENTS *zk-content
================================================================================ ================================================================================
ZK-NVIM *zk-zk-nvim* ZK-NVIM *zk-zk-nvim*
Neovim extension for the `zk` (https://github.com/mickael-menu/zk) plain text note-taking assistant. Neovim extension for the `zk` (https://github.com/zk-org/zk) plain text note-taking assistant.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
REQUIREMENTS *zk-requirements* REQUIREMENTS *zk-requirements*
@ -36,12 +36,12 @@ INSTALLATION *zk-installatio
Via packer.nvim (https://github.com/wbthomason/packer.nvim) Via packer.nvim (https://github.com/wbthomason/packer.nvim)
> >
use("mickael-menu/zk-nvim") use("zk-org/zk-nvim")
< <
Via vim-plug (https://github.com/junegunn/vim-plug) Via vim-plug (https://github.com/junegunn/vim-plug)
> >
Plug "mickael-menu/zk-nvim" Plug "zk-org/zk-nvim"
< <
To get the best experience, it's recommended to also install either Telescope (https://github.com/nvim-telescope/telescope.nvim) or fzf (https://github.com/junegunn/fzf). To get the best experience, it's recommended to also install either Telescope (https://github.com/nvim-telescope/telescope.nvim) or fzf (https://github.com/junegunn/fzf).
@ -97,9 +97,9 @@ However, this is always optional, and usually not necessary.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
GETTING STARTED *zk-getting_started* GETTING STARTED *zk-getting_started*
After you have installed the plugin and added the setup code to your config, you are good to go. If you are not familiar with `zk`, we recommend you to also read the `zk` docs (https://github.com/mickael-menu/zk/tree/main/docs). After you have installed the plugin and added the setup code to your config, you are good to go. If you are not familiar with `zk`, we recommend you to also read the `zk` docs (https://github.com/zk-org/zk/tree/main/docs).
When using the default config, the `zk` LSP client will automatically attach itself to buffers inside your notebook and provide capabilities like completion, hover and go-to-definition; see https://github.com/mickael-menu/zk/issues/22 for a full list of what is supported. When using the default config, the `zk` LSP client will automatically attach itself to buffers inside your notebook and provide capabilities like completion, hover and go-to-definition; see https://github.com/zk-org/zk/issues/22 for a full list of what is supported.
Try out different commands (#built-in-commands) such as `:ZkNotes` or `:ZkNew`, see what they can do, and learn as you go. Try out different commands (#built-in-commands) such as `:ZkNotes` or `:ZkNew`, see what they can do, and learn as you go.
@ -108,25 +108,25 @@ BUILT-IN COMMANDS *zk-built-in_command
> >
" Indexes the notebook " Indexes the notebook
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
:ZkIndex [{options}] :ZkIndex [{options}]
< <
> >
" Creates and edits a new note " Creates and edits a new note
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:ZkNew [{options}] :ZkNew [{options}]
< <
> >
" Creates a new note and uses the last visual selection as the title while replacing the selection with a link to the new note " Creates a new note and uses the last visual selection as the title while replacing the selection with a link to the new note
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:'<,'>ZkNewFromTitleSelection [{options}] :'<,'>ZkNewFromTitleSelection [{options}]
< <
> >
" Creates a new note and uses the last visual selection as the content while replacing the selection with a link to the new note " Creates a new note and uses the last visual selection as the content while replacing the selection with a link to the new note
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
:'<,'>ZkNewFromContentSelection [{options}] :'<,'>ZkNewFromContentSelection [{options}]
< <
> >
@ -138,36 +138,36 @@ BUILT-IN COMMANDS *zk-built-in_command
> >
" Opens a notes picker " Opens a notes picker
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkNotes [{options}] :ZkNotes [{options}]
< <
> >
" Opens a notes picker for the backlinks of the current buffer " Opens a notes picker for the backlinks of the current buffer
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkBacklinks [{options}] :ZkBacklinks [{options}]
< <
> >
" Opens a notes picker for the outbound links of the current buffer " Opens a notes picker for the outbound links of the current buffer
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:ZkLinks [{options}] :ZkLinks [{options}]
< <
> >
" Opens a notes picker, filters for notes that match the text in the last visual selection " Opens a notes picker, filters for notes that match the text in the last visual selection
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
:'<,'>ZkMatch [{options}] :'<,'>ZkMatch [{options}]
< <
> >
" Opens a notes picker, filters for notes with the selected tags " Opens a notes picker, filters for notes with the selected tags
" params " params
" (optional) additional options, see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist " (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
:ZkTags [{options}] :ZkTags [{options}]
< <
The `options` parameter can be any valid Lua expression that evaluates to a table. The `options` parameter can be any valid Lua expression that evaluates to a table.
For a list of available options, refer to the `zk` docs (https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#custom-commands). For a list of available options, refer to the `zk` docs (https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#custom-commands).
In addition, `options.notebook_path` can be used to explicitly specify a notebook by providing a path to any file or directory within the notebook; see Notebook Directory Discovery (#notebook-directory-discovery). In addition, `options.notebook_path` can be used to explicitly specify a notebook by providing a path to any file or directory within the notebook; see Notebook Directory Discovery (#notebook-directory-discovery).
Examples: Examples:
@ -251,14 +251,14 @@ It's mainly used for the implementation of built-in and custom commands.
---Creates and edits a new note ---Creates and edits a new note
-- --
---@param options? table additional options ---@param options? table additional options
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
require("zk").new(options) require("zk").new(options)
< <
> >
---Indexes the notebook ---Indexes the notebook
-- --
---@param options? table additional options ---@param options? table additional options
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
require("zk").index(options) require("zk").index(options)
< <
> >
@ -267,7 +267,7 @@ It's mainly used for the implementation of built-in and custom commands.
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
require("zk").pick_notes(options, picker_options, cb) require("zk").pick_notes(options, picker_options, cb)
< <
@ -277,7 +277,7 @@ It's mainly used for the implementation of built-in and custom commands.
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
---@see zk.ui.pick_tags ---@see zk.ui.pick_tags
require("zk").pick_tags(options, picker_options, cb) require("zk").pick_tags(options, picker_options, cb)
< <
@ -286,7 +286,7 @@ It's mainly used for the implementation of built-in and custom commands.
-- --
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
require("zk").edit(options, picker_options) require("zk").edit(options, picker_options)
< <
@ -300,7 +300,7 @@ You can use it to write your own specialized functions for interacting with `zk`
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
require("zk.api").index(path, options, function(err, stats) require("zk.api").index(path, options, function(err, stats)
-- do something with the stats -- do something with the stats
end) end)
@ -309,7 +309,7 @@ You can use it to write your own specialized functions for interacting with `zk`
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
require("zk.api").new(path, options, function(err, res) require("zk.api").new(path, options, function(err, res)
file_path = res.path file_path = res.path
-- do something with the new file path -- do something with the new file path
@ -319,7 +319,7 @@ You can use it to write your own specialized functions for interacting with `zk`
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options table additional options ---@param options table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
require("zk.api").list(path, options, function(err, notes) require("zk.api").list(path, options, function(err, notes)
-- do something with the notes -- do something with the notes
end) end)
@ -328,7 +328,7 @@ You can use it to write your own specialized functions for interacting with `zk`
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
require("zk.api").tag.list(path, options, function(err, tags) require("zk.api").tag.list(path, options, function(err, tags)
-- do something with the tags -- do something with the tags
end) end)
@ -449,7 +449,7 @@ Note that if you are using `nvim-treesitter` for Markdown, don't forget to enabl
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
NVIM-LSP-INSTALLER *zk-nvim-lsp-installer* NVIM-LSP-INSTALLER *zk-nvim-lsp-installer*
> >
Not recommended, instead install the `zk` (https://github.com/mickael-menu/zk) CLI tool and make it available in your `$PATH`. Not recommended, instead install the `zk` (https://github.com/zk-org/zk) CLI tool and make it available in your `$PATH`.
< <
If you insist to use nvim-lsp-installer for `zk`, the following code snippet should guide you on how to setup the `zk` server when installed via nvim-lsp-installer. If you insist to use nvim-lsp-installer for `zk`, the following code snippet should guide you on how to setup the `zk` server when installed via nvim-lsp-installer.

4
lua/telescope/_extensions/zk.lua
Unescape Escape View File

@ -1,13 +1,13 @@
local zk = require("zk") local zk = require("zk")
---@param opts? table additional options for zk, telescope options, all optional and in one table ---@param opts? table additional options for zk, telescope options, all optional and in one table
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
local function show_notes(opts) local function show_notes(opts)
zk.edit(opts, { picker = "telescope", telescope = opts }) zk.edit(opts, { picker = "telescope", telescope = opts })
end end
---@param opts? table additional options for zk, telescope options, all optional and in one table ---@param opts? table additional options for zk, telescope options, all optional and in one table
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
local function show_tags(opts) local function show_tags(opts)
zk.pick_tags(opts, { picker = "telescope", telescope = opts }, function(tags) zk.pick_tags(opts, { picker = "telescope", telescope = opts }, function(tags)
tags = vim.tbl_map(function(v) tags = vim.tbl_map(function(v)

10
lua/zk.lua
Unescape Escape View File

@ -62,7 +62,7 @@ end
---Creates and edits a new note ---Creates and edits a new note
-- --
---@param options? table additional options ---@param options? table additional options
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
function M.new(options) function M.new(options)
options = options or {} options = options or {}
api.new(options.notebook_path, options, function(err, res) api.new(options.notebook_path, options, function(err, res)
@ -78,7 +78,7 @@ end
-- --
---@param options? table additional options ---@param options? table additional options
---@param cb? function for processing stats ---@param cb? function for processing stats
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
function M.index(options, cb) function M.index(options, cb)
options = options or {} options = options or {}
cb = cb or function(stats) cb = cb or function(stats)
@ -95,7 +95,7 @@ end
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
function M.pick_notes(options, picker_options, cb) function M.pick_notes(options, picker_options, cb)
options = vim.tbl_extend("force", { select = ui.get_pick_notes_list_api_selection(picker_options) }, options or {}) options = vim.tbl_extend("force", { select = ui.get_pick_notes_list_api_selection(picker_options) }, options or {})
@ -110,7 +110,7 @@ end
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@param cb function ---@param cb function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
---@see zk.ui.pick_tags ---@see zk.ui.pick_tags
function M.pick_tags(options, picker_options, cb) function M.pick_tags(options, picker_options, cb)
options = options or {} options = options or {}
@ -124,7 +124,7 @@ end
-- --
---@param options? table additional options ---@param options? table additional options
---@param picker_options? table options for the picker ---@param picker_options? table options for the picker
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
---@see zk.ui.pick_notes ---@see zk.ui.pick_notes
function M.edit(options, picker_options) function M.edit(options, picker_options)
M.pick_notes(options, picker_options, function(notes) M.pick_notes(options, picker_options, function(notes)

10
lua/zk/api.lua
Unescape Escape View File

@ -28,7 +28,7 @@ end
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zkindex ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zkindex
function M.index(path, options, cb) function M.index(path, options, cb)
execute_command("index", path, options, cb) execute_command("index", path, options, cb)
end end
@ -36,7 +36,7 @@ end
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zknew ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zknew
function M.new(path, options, cb) function M.new(path, options, cb)
execute_command("new", path, options, cb) execute_command("new", path, options, cb)
end end
@ -46,7 +46,7 @@ end
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table Extra options; table in form {title: string} ---@param options? table Extra options; table in form {title: string}
---@param cb? function callback function ---@param cb? function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklink ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklink
function M.link(target, location, path, options, cb) function M.link(target, location, path, options, cb)
options = vim.tbl_extend("force", { path = target, location = location }, options or {}) options = vim.tbl_extend("force", { path = target, location = location }, options or {})
@ -56,7 +56,7 @@ end
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options table additional options ---@param options table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zklist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zklist
function M.list(path, options, cb) function M.list(path, options, cb)
execute_command("list", path, options, cb) execute_command("list", path, options, cb)
end end
@ -66,7 +66,7 @@ M.tag = {}
---@param path? string path to explicitly specify the notebook ---@param path? string path to explicitly specify the notebook
---@param options? table additional options ---@param options? table additional options
---@param cb function callback function ---@param cb function callback function
---@see https://github.com/mickael-menu/zk/blob/main/docs/editors-integration.md#zktaglist ---@see https://github.com/zk-org/zk/blob/main/docs/editors-integration.md#zktaglist
function M.tag.list(path, options, cb) function M.tag.list(path, options, cb)
execute_command("tag.list", path, options, cb) execute_command("tag.list", path, options, cb)
end end

2
lua/zk/util.lua
Unescape Escape View File

@ -47,7 +47,7 @@ function M.get_lsp_location_from_selection()
local params = vim.lsp.util.make_given_range_params() local params = vim.lsp.util.make_given_range_params()
return { return {
uri = params.textDocument.uri, uri = params.textDocument.uri,
range = M.get_selected_range(), -- workaround for neovim 0.6.1 bug (https://github.com/mickael-menu/zk-nvim/issues/19) range = M.get_selected_range(), -- workaround for neovim 0.6.1 bug (https://github.com/zk-org/zk-nvim/issues/19)
} }
end end

Write Preview
Loading…
Cancel
Save