Skip to content

Commit

Permalink
docs(readme): remove plenary, add pathlib
Browse files Browse the repository at this point in the history
  • Loading branch information
jghauser committed Jun 4, 2024
1 parent 98d8f92 commit 3291b25
Showing 1 changed file with 34 additions and 25 deletions.
59 changes: 34 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,59 +73,69 @@ To run, papis.nvim requires the [yq](https://github.com/mikefarah/yq) utility to

You'll need the [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) plugin if you intend to use the completion module.

### Package managers
### Neovim package managers

With rocks.nvim:
In addition to the below snippets, make sure to also install the *treesitter yaml parser* if you intend to use the completion module.

<details>
<summary>rocks.nvim configuration</summary>

```vim
:Rocks install papis.nvim
```

With packer:
</details>

<details>
<summary>lazy.nvim configuration</summary>

```lua
use({
{
"jghauser/papis.nvim",
after = { "telescope.nvim", "nvim-cmp" },
requires = {
dependencies = {
"kkharji/sqlite.lua",
"nvim-lua/plenary.nvim",
"pysan3/pathlib.nvim"
"MunifTanjim/nui.nvim",
},
config = function()
require("papis").setup(
require("papis").setup({
-- Your configuration goes here
)
})
end,
})
}
```

With lazy.nvim:
</details>

<details>
<summary>packer configuration</summary>

```lua
{
use({
"jghauser/papis.nvim",
dependencies = {
after = { "telescope.nvim", "nvim-cmp" },
requires = {
"kkharji/sqlite.lua",
"nvim-lua/plenary.nvim",
"pysan3/pathlib.nvim"
"MunifTanjim/nui.nvim",
},
config = function()
require("papis").setup({
require("papis").setup(
-- Your configuration goes here
})
)
end,
}
})
```

Additional dependencies:

- *treesitter yaml parser*: Required by the completion module.
</details>

### Nix

The `flake.nix` provides an overlay that can be used to install `papis.nvim`. With `home-manager`, this can be achieved with something along the following lines:

<details>
<summary>Nix configuration</summary>

```nix
{
inputs = {
Expand Down Expand Up @@ -158,6 +168,8 @@ The `flake.nix` provides an overlay that can be used to install `papis.nvim`. Wi
}
```

</details>

## Setup

Papis.nvim exposes a rather large number of configuration options, most of which can be left alone -- and quite a few of which probably *should* be left alone (or not, if you're feeling brave). Currently, papis.nvim doesn't check whether you've managed to set incompatible options, and weird failures will likely occur in such instances.
Expand Down Expand Up @@ -398,12 +410,9 @@ init_filetypes = { "markdown", "norg", "yaml" },
-- Configuration of logging.
log = {

-- What levels to log (`off` to disable). Debug mode is more conveniently
-- What levels to log. Debug mode is more conveniently
-- enabled in `enable_modules`.
level = "off",

-- How to format log strings.
notify_format = "%s",
level = "info",
},
```

Expand Down

0 comments on commit 3291b25

Please sign in to comment.