Skip to content

Commit

Permalink
Remove references to old repo (#158)
Browse files Browse the repository at this point in the history
as part of project handover, references to github.com/mickael-menu/zk-nvim are removed. 
Now pointing to ../zk-org/zk-nvim
  • Loading branch information
mcDevnagh authored Jan 4, 2024
1 parent 1426256 commit 094132d
Show file tree
Hide file tree
Showing 8 changed files with 67 additions and 67 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ body:
attributes:
label: If you have an idea, open a discussion
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 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/support.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ body:
attributes:
label: If you need help, open a discussion
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 changes: 27 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 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

Expand All @@ -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)
```lua
use("mickael-menu/zk-nvim")
use("zk-org/zk-nvim")
```

Via [vim-plug](https://github.com/junegunn/vim-plug)
```viml
Plug 'mickael-menu/zk-nvim'
Plug 'zk-org/zk-nvim'
```

Via [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"mickael-menu/zk-nvim",
"zk-org/zk-nvim",
config = function()
require("zk").setup({
-- See Setup section below
Expand Down Expand Up @@ -83,9 +83,9 @@ However, this is always optional, and usually not necessary.

## 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.

Expand All @@ -94,7 +94,7 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim
" Indexes the notebook
" 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}]
```

Expand All @@ -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.
"
" 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}]
```

Expand All @@ -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.
"
" 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}]
```

Expand All @@ -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.
"
" 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}]
```

Expand All @@ -138,28 +138,28 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim
" Opens a notes picker
" 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}]
```

```vim
" Opens a notes picker for the backlinks of the current buffer
" 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}]
```

```vim
" Opens a notes picker for the outbound links of the current buffer
" 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}]
```

```vim
" Inserts a link at the cursor location or around the selected text.
" 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.
" e.g. :'<'>ZkInsertLinkAtSelection {matchSelected = true}
:ZkInsertLink
Expand All @@ -169,19 +169,19 @@ Try out different [commands](#built-in-commands) such as `:ZkNotes` or `:ZkNew`,
```vim
" Opens a notes picker, filters for notes that match the text in the last visual selection
" 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}]
```

```vim
" Opens a notes picker, filters for notes with the selected tags
" 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}]
```

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).

*Examples:*
Expand Down Expand Up @@ -269,15 +269,15 @@ require("zk").cd(options)
---Creates and edits a new note
--
---@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)
```

```lua
---Indexes the notebook
--
---@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)
```

Expand All @@ -287,7 +287,7 @@ require("zk").index(options)
---@param options? table additional options
---@param picker_options? table options for the picker
---@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
require("zk").pick_notes(options, picker_options, cb)
```
Expand All @@ -298,7 +298,7 @@ require("zk").pick_notes(options, picker_options, cb)
---@param options? table additional options
---@param picker_options? table options for the picker
---@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
require("zk").pick_tags(options, picker_options, cb)
```
Expand All @@ -308,7 +308,7 @@ require("zk").pick_tags(options, picker_options, cb)
--
---@param options? table additional options
---@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
require("zk").edit(options, picker_options)
```
Expand All @@ -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 options? table additional options
---@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)
-- do something with the stats
end)
Expand All @@ -332,7 +332,7 @@ end)
---@param path? string path to explicitly specify the notebook
---@param options? table additional options
---@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)
file_path = res.path
-- do something with the new file path
Expand All @@ -343,7 +343,7 @@ end)
---@param path? string path to explicitly specify the notebook
---@param options table additional options
---@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)
-- do something with the notes
end)
Expand All @@ -353,7 +353,7 @@ end)
---@param path? string path to explicitly specify the notebook
---@param options? table additional options
---@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)
-- do something with the tags
end)
Expand Down Expand Up @@ -480,7 +480,7 @@ require("nvim-treesitter.configs").setup({
```

## 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.

Expand Down
Loading

0 comments on commit 094132d

Please sign in to comment.